Skip to content

Latest commit

 

History

History
142 lines (99 loc) · 3.92 KB

README.md

File metadata and controls

142 lines (99 loc) · 3.92 KB

Boilerplate Next

Este boilerplate é um ponto de partida para projetos que utilizam Next.js. Ele contém uma estrutura básica para desenvolvimento, testes e produção, assim como configurações de estilo, internacionalização, otimização de performance e monitoramento de erros.

Requisites

Env vars

Name Description Get From Where to store/setup Default

Scripts disponíveis

No diretório do projeto, você pode executar:

yarn dev

Executa o aplicativo em modo de desenvolvimento.
Abra http://localhost:3000 para visualizar no navegador.

yarn build

Compila o aplicativo para produção na pasta .next.

yarn start

Inicia um servidor de produção com o aplicativo compilado.

yarn format

Formata o código fonte com Prettier.

yarn eslint:init

Inicia a configuração do Eslint em seu projeto.

yarn eslint:fix

Roda o Eslint em todo o projeto para corrigir erros.

yarn lint-staged

Configura o lint-staged para rodar na pre-commit do git.

yarn test:watch

Executa testes em modo watch.

yarn test

Executa todos os testes.

yarn cypress

Abre a interface gráfica do Cypress.

yarn cypress:headless

Executa testes do Cypress em modo headless.

yarn e2e

Executa os testes end-to-end em um servidor local.

yarn e2e:headless

Executa os testes end-to-end em modo headless.

Dependências

  • Next.js - Framework de renderização de páginas em React;
  • React - Biblioteca JavaScript para construir interfaces de usuário;
  • Framer Motion - Biblioteca de animações;
  • Moment - Biblioteca para manipulação de datas e horas;
  • UUID - Biblioteca para geração de identificadores únicos;
  • Next-i18next - Biblioteca para internacionalização;
  • Next-pwa - Biblioteca para criação de Progressive Web Apps;
  • Sentry - Plataforma de monitoramento de erros em tempo real;

Dependências de Desenvolvimento

  • Test
    • Jest - Framework de testes;
    • Cypress - Ferramenta de testes end-to-end;
  • Lint
    • Eslint - Ferramenta de análise de código;
    • Prettier - Formatador de código;
    • Husky - Biblioteca para automatizar hooks do git;
    • Lint-staged - Biblioteca para rodar linters em arquivos modificados no commit;
  • Package
    • TypeScript - Superset do JavaScript;
    • Webpack - Bundler de módulos;

app

  1. Create icons/* to pwa
  2. Duplicate: cp .env.example .env

See .env.example.

  1. Edit: vim .env

without the environment variables the form, login and dashboard pages do not work

  1. yarn install

Starting the server

Start local

yarn dev

Examples

Refs