Dúvidas e sugestões de melhoria são bem-vindas! Entre em contato ou abra uma Issue ou um Pull Request as reportando!
Para trocar as configurações do Docker/site, mude as variáveis no arquivo .env. Ele é craido automaticamente quando um script do docker é chamado.
Execute os comandos apresentados nessa seção em uma shell Linux.
Para rodar o site (em mode de desenvolvimento), execute
docker/up.sh
Para pará-lo, execute CTRL+C.
Para se conectar a shell do Container, execute
docker/run.sh
Para sair da shell do container, execute CTRL+D ou exit.
Para apagar os Containers, imagens, volumes e redes do projeto, execute
docker/down.sh
Execute os comandos apresentados nessa seção na shell do container.
Para instalar as dependências do site, execute
npm ci
Para rodar o site em mode de desenvolvimento, execute
npm start
Para pará-lo, execute CTRL+C.
Para criar o código de produção do site, execute
npm run build
Para rodar o site em mode de produção, execute
npm run prod
Para pará-lo, execute CTRL+C.
Execute os comandos apresentados nessa seção na shell do container.
As métricas de qualidade do projeto são reproduzidas pela etapas de integração contínua do projeto. Configurações das etapas de integração contínua descritas no arquivo .github/workflows/ci.yml.
Para rodar os testes e relatório de cobertura, execute
npm test
Para ver o relatório html, confira coverage-results/lcov-report/index.html.
Configurações dos testes e relatório de cobertura descritas no arquivo jest.config.ts.
Para rodar o linter de código JavaScript, execute
npm run lint
Configurações do linter de JavaScript descritas no arquivo .eslintrc.js.
Para formatar código JavaScript, execute
npm run lint -- --fix
Configurações do formatador de código JavaScript no arquivo .prettierrc.js.
Para checar vulnerabilidades de segurança conhecidas nas dependências JavaScript, execute
npm audit
Para checar dependências JavaScript desatualizadas, execute
npm outdated --long
Esse repositório é licenciado sob os termos da MIT License.