Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.65 KB

README.md

File metadata and controls

51 lines (35 loc) · 1.65 KB
Raw

🚀 Welcome to Storybook Project!


project image

Descrição

A aplicação demonstra um componente de loading e diversos botões, com o intuito de criar testes e documentação com a biblioteca storybook.

Tecnologias Utilizadas

  • React.js
  • Next.js
  • TypeScript
  • Styled Components
  • Storybook
  • Jest
  • Testing Library

Como Rodar o Projeto

  1. Clone este repositório em sua máquina.
  2. Na pasta raiz do projeto, execute npm install ou yarn install para instalar as dependências.
  3. Para iniciar a aplicação em modo de desenvolvimento, execute npm run dev ou yarn dev.
  4. Para executar os testes, execute npm run test ou yarn test.
  5. Para visualizar os componentes com o Storybook, execute npm run storybook ou yarn storybook.

Como Rodar os Testes

  1. Na pasta raiz do projeto, execute npm test ou yarn test.
  2. Os testes serão rodados e renderizados no terminal do seu compilador.

Como Visualizar a Documentação do Storybook

  1. Na pasta raiz do projeto, execute npm storybook ou yarn storybook.
  2. Você será redirecionado para a página do Storybook, onde poderá navegar pelos diferentes componentes e visualizar sua documentação, exemplos e histórias.

Como Contribuir

  1. Faça um fork deste repositório.
  2. Crie um branch com sua feature: git checkout -b minha-feature.
  3. Faça commit de suas alterações: git commit -m 'Adicionando nova feature'.
  4. Faça push para o branch: git push origin minha-feature.
  5. Abra um pull request para o repositório original.