Skip to content

README.md

Latest commit

 

History

History
67 lines (46 loc) · 1.49 KB

README.md

File metadata and controls

67 lines (46 loc) · 1.49 KB

Back-end do site da SAEComp

Como rodar para desenvolvimento

Adicionar .env com:

PORT=3000
DB_HOST=localhost
DB_PORT=5433
DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=saecomp

npm install

npm run dev

Para rodar o db de testes: docker compose up

A documentação vai estar disponível em http://localhost:3000/api/docs

Como criar a build do projeto

npm install

Alterar ORIGIN_URL para o CORS não bloquear

npm run build

npm run start

Os arquivos de build ficam disponíveis no diretório dist

Como fazer contribuições

Utilize o GitHub Flow como fluxo para alterar o código do repositório

Exemplo:

  1. Crie uma nova branch a partir da main:
git checkout -b feature/<nome-da-feature>
  1. Faça as alterações localmente e use commits seguindo o padrão Conventional Commits:

feat: <descrição da feature>

fix: <descrição do erro corrigido>

  1. Suba a branch para o GitHub:
git push origin feature/<nome-da-feature>
  1. Abra um PR (pull request) para a branch main:
  • Descreva o que foi feito
  • Relacione algum issue, caso ele exista
  • Escolha pelo menos um revisor para aprovar sua alteração
  1. Caso o PR seja aprovado, faça merge na main

© SAEComp <3
Secretaria Acadêmica da Engenharia de Computação | USP São Carlos