@patrick_gratao/bigbrainui
v0.0.7
Published
<h1 align="center" style="background-color: #383839"> <br /> <img alt="big brain" src="https://brainz.group/wp-content/themes/brainz-group/assets/BrainzGroupLogo.svg" /> <br /><br /> </h1>
Downloads
1
Readme
Visão Geral
O objetivo deste projeto é fornecer componentes customizados para que todas as aplicações da Big Brain possam utilizar.
Tecnologias utilizadas
- ⚛️ React 18
- ⛑ TypeScript
- ⛑ Vite
- 📏 Biome JS - Linter e Formatter
- 🖌 Styled components e Tailwind
- 🧪 Vitest e React Testing Library
- 🖌 Storybook
Organização de Pastas e Arquivos
Pasta public
Esta pasta contém os arquivos de públicos do app e também logo e favicon.
Pasta src
Esta pasta contém os arquivos que utilizaremos no dia a dia da aplicação.
Subpasta src/components
Nesta subpasta estarão presentes os arquivos de componentes da aplicação.
Subpasta src/pages
Dentro desta pasta estão as páginas da aplicação.
Que deverão ser instanciadas no arquivo Routes.tsx
Subpasta src/styles
Nesta subpasta estarão presentes os arquivos de estilo.
Como instalar?
Requisitos Mínimos
- Necessário ter no mínimo o npm
9.5
- Necessário ter no mínimo o node
18.14.x
Instalação
- Baixe ou clone este repositório
- Acesse a pasta baixada e instale as dependências com
npm install
ouyarn install
- Rode o comando
npm run dev
Após rodar o comando de run
será aberto uma janela com a url localhost:3000
.
Rodar os Testes
- Rode o comando
npm run test
Feito com 💗 pelo Time de Produto - Brainz Group