npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tst-labs/basilar

v0.2.0

Published

Biblioteca de componentes React/MUI de base para os projetos front end do TST.

Downloads

4

Readme

BASILAR

A @tst-labs/basilar é uma proposta de biblioteca de componentes, inicialmente direcionada aos desenvolvedores do TST, contendo as bases necessárias para a construção de UIs em React e Material UI, que leva em consideração os elementos (design tokens) estabelecidos pelo Manual de Identidade Visual JT/TST.

Nesse primeiro momento, a @tst-labs/basilar está configurada para usar as versões v5.6.4 da MUI e v18.1.0 do React. Em um momento futuro (não muito distante) pretendemos torná-la compatível com as versões mais antigas em uso nos projetos de front end em produção no TST.

Começando a usar (Getting Started)

Instale a @tst-labs/basilar como dependência no seu projeto React

yarn add @tst-labs/basilar

Recomendamos o uso de yarn em seus projetos, mas não é uma exigência.

Em seguida é só escolher que funcionalidades exportadas pela @tst-labs/basilar deseja usar no seu projeto. Por exemplo, use o tema padrão do TST em seu projeto:

import React from 'react';
import ReactDOM from 'react-dom/client';
import CssBaseline from '@mui/material/CssBaseline';

import { ProvedorTemaTST } from '@tst-labs/basilar';

import App from './app/app';

import './index.css';

const root = ReactDOM.createRoot(document.getElementById('root'));

root.render(
  <React.StrictMode>
    <ProvedorTemaTST>
      <CssBaseline />
      <App />
    </ProvedorTemaTST>
  </React.StrictMode>
);

Pré-requisitos (ambiente de desenvolvimento e uso)

Usamos Node.js v16.x, mas já foi testada com v14.x e funciona bem. Recomendamos o uso do nvm para gerencia as versões do Node em sua máquina de trabalho.

Scripts do projeto

Usamos o yarn nesse projeto. No diretório do projeto você pode executar os seguintes de scripts:

yarn build

Empacota a biblioteca, usando o rollup, no diretório dist/.

yarn build-watch

Empacota a biblioteca, usando o rollup, no diretório dist/ e fica verificando alterações a serem reempacotadas.

yarn test

Inicia uma sessão interativa de testes executando react-scripts test.

yarn test:ci

Executa react-scripts test mas configurado para ser usado em pipelines de CI/CD.

Como adicionar novos componentes

Adotaremos um processo de trabalho manual para adicionar novos componentes à @tst-labs/basilar descrita nos passos a seguir.

1. Clone o repositório em seu host de trabalho:

# ### Pode usar https ou ssh, como preferir. Abaixo uso SSH.
git clone [email protected]:tst-labs/basilar.git
# ### Mude para o diretório do projeto
cd basilar

2. Instale as dependências:

# ### IMPORTANTE: Usamos o yarn nesse projeto. Evite problemas!
yarn
# ### Ou
# yarn install

3. Insira novos componentes, seus testes e histórias (Storybook stories):

Os componentes deverão ser organizados abaixo do diretório src/componentes/ em diretórios próprios e exportados em arquivos index.js. O diretório raíz dos componentes (supracitado) tem o index.js que exporta tudo da biblioteca.

Explore o diretório de componentes para ter ideia de como organizar os novos componentes.

4. Exponha a biblioteca no seu host para uso em outros projetos:

# ### Ao usar o yarn link você instalará a biblioteca no repositório global do host.
# ### No diretório raíz do projeto execute o seguinte comando:
yarn link

5. Link a biblioteca ao seu projeto final:

# ### No diretório raíz do projeto que usará a biblioteca execute o seguinte comando:
yarn link @tst-labs/basilar

Agora é só incluir o novo componente e testar em sua aplicação.

6. Crie uma nova branch de trabalho para submeter o(s) novo(s) componente(s):

# ### No diretório raíz do projeto:
git checkout -b novo-componente-fantastico
# ### Envie a nova *branch* para o repositório principal no Github:
git push --set-upstream origin novo-componente-fantastico

E crie um novo Pull Request explicando o que está sendo proposto para inclusão na biblioteca. Marque o PR como WIP (Work In Progress) para evitar que seja incorporado à biblioteca acidentalmente.

Essa conversa pode demorar caso haja alguma discordância entre os mantenedores sobre o componente sendo proposto, por isso não é bom contar com uma atualização automática da biblioteca tão logo o código seja enviado ao repositório principal.

Etapas posteriores

Assim que os MRs abertos sejam aceitos a documentação em Storybook da biblioteca já será atualizada, mas a biblioteca em si ainda dependerá de uma release para que seja publicada em uma nova versão na registry do npmjs.com.

Como contribuir

TODO:

Licença

Usamos licença MIT para esse projeto.

Colaboradores

  • @lemos.dev