Next Boilerplate

Configurações básicas e objetivas do boilerplate:

Next
Framework base. Conheça.

Typescript
Linguagem (Superset Javascript) base. Conheça.

ESLint
Lib responsável por manter a padronização do código. Conheça.

Jest e React Testing Library
Responsável pela criação e execução dos testes. Conheça.

Tailwind CSS
Responsável pelas classes pré-definidas utilizadas na construção da aplicação. Conheça.

Hero Icons
Pacote de Ícones gratuitos. Conheça.

Estrutura de Arquivos

src
Raiz da aplicação

components
Responsável por organizar toda a estrutura de componentes reutilizáveis

contexts
Responsável por organizar todos os contextos da aplicação

domain
Responsável pelo Core da aplicação, podendo conter as seguintes subspastas (Mas não limitado à elas):

domain/enums
Responsável pelos Enumerators

domain/entities
Responsável pelas Entidades

domain/interfaces
Responsável pelas Interfaces

hooks
Responsável pelos Custom Hooks

pages
Parte da estrutura básica do Next e responsável pelas páginas e roteamento da aplicação. Leia a documentação e entenda seu funcionamento.

pages/api Parte da estrutura base do Next e responsável pelas API's. Leia a documentação e entenda seu funcionamento.

styles
Responsável por toda a questão de estilização da aplicação

Comandos

yarn dev
Executa localmente na porta 3000

yarn build
Gera o build da aplicação

yarn start
Starta a aplicação à partir do build

yarn lint
Executa o Lint em busca de código fora do padrão definido

yarn test
Roda todos os testes

yarn test:coverage
Gera os testes e o relatório de cobertura

yarn test:dev
Mantém os testes rodando e assistindo à qualquer modificação

yarn test:preview
Inicia o Jest Preview para visualizar o componente que está sendo testado (Para mais detalhes, veja a documentação)