Projeto de engenharia de software experimental
.Env
Altere .envExemple para .env e altere as informações contidas.
Documentação dos endpoints
Documentação para baixar via Postman Documentação online
Tipos de commit
| Tipo de commit | Descrição | Release |
|---|---|---|
feat |
Uma nova feature | minor |
fix |
Correção de bugs | patch |
docs |
Documentação | patchse o escopo for readme |
style |
Formatação de código | Alterações que não afetam o significado do código (espaços em branco, identação, ponto-e-virgula, etc) |
refactor |
Refatoração de código | Alteração no código que não corrige um bug, e nem adiciona uma feature |
perf |
Melhorias de performance | Alteração no código que melhora a performance |
build |
Builds | Alterações que afetam o sistema de build, ou dependências externas (escopos exemplares: gulp, broccoli, yarn, npm, webpack) |
ci |
Integração continua (CI) | Alteração aos arquivos de configuração e scripts do CI (escopos exemplares: travis, circleci, browserstack, saucelabs) |
chore |
Chores | Outras mudanças que não modificam os arquivos da aplicação ou dos testes |
revert |
Reversão de commit | Reversão a um commit anterior |
Algumas Boas práticas
- Adicionar Resolver apenas quando necessário
- Remover qualquer biblioteca não utilizada do
package.json - Utilizar TSlint
Bibliotecas
A lista de dependências abaixo não leva em consideração pacotes essenciais para o workflow, como por exemplo, os que possuam prefixos e
@types, includingrxjs,tslibezone.js
- ts-node-dev: Re-inicia o processo node quando um arquivo e atualizado.
- Express: Minimalista web framework para node.
- DotEnv: Modulo para carregar as variável de ambiente.
- Cors: Pacote que permite habilitar CORS.
Servidor de desenvolvimento
Execute npm rum dev para iniciar um servidor de desenvolvimento. Navegue ao http://localhost:3333/.