Skip to content

creation of loading component and buttons for documentation in the storybook.

Notifications You must be signed in to change notification settings

Mornieur/storybook-project

Repository files navigation

šŸš€ 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.