Hi there! 👋

This project was developed with care and in the best way I could with the knowledge I have, I hope you enjoy it! 🥳

What is inside?

• Next
• ReactJS
• TypeScript
• Styled Components
• Storybook
• Jest
• React Testing Library
• Eslint
• Prettier
• Husky
• Commitlint

Getting Started

Install dependencies:

yarn

or

npm install

Run development server

yarn dev

or

npm run dev

Open http://localhost:3000 with your browser to see the result.

Structure

└── src
    ├── __helpers__
    ├── components
    ├── pages
    ├── styles

Folder	Description
helpers	Functions to handle the tests
components	Page components
pages	Pages components
styles	Application styles

Conventions

Components

└── <MyComponent>
    ├── <MyComponent>.tsx
    ├── <MyComponent>.test.tsx
    ├── <MyComponent>.styled.ts
    ├── <MyComponent>.stories.tsx
    └── index.ts

Files	Description
.tsx	Component implementation
.test.tsx	Component tests
.styled.ts	Component stylesheet using styled-components
.stories.tsx	Storybook component
index.ts	File to export the component

Commands

• dev: run development server
• build: creates the production build version
• lint: runs the linter in all components and pages
• test: runs jest to test all components and pages
• storybook: runs docs with storybook

Made with 💜 by Giovanna