Home

Bem vindo

Módulos da API

O endpoint de raiz retorna a string "FishNet API". Funcionalidades do sistema foram divididas nos seguintes módulos:

• Autenticação /auth
• Usuários /users
• Produtos /prods
• Analítica /dash
• Vendas /sales
• Administração /admin

Setup do projeto

Crie um arquivo .env na raiz do projeto e copie os valores disponíveis no canal 🔒 Segredos no Discord da equipe.

MONGODB_USER=***
MONGODB_PASSWORD=***
MONGODB_URI=***
EMAIL_ADDR=***
EMAIL_PASSWORD=***
SECRET_KEY=***

Política de branches

A branch main está bloqueada. É impossível realizar um commit diretamente até ela. Crie uma branch para a feature que está desenvolvendo e dê commit nela.

As features serão coletadas na main através de pull requests, não merges. Quando julgar que sua feature está apta para ser integrada à versão de produção, crie um pull request main <- feature Às sextas-feiras será realizada uma revisão e merge dos pull requests pelo administrador.

Caso a feature não esteja apta para ser integrada, o contribuidor será notificado com um comentário no seu pull request e uma issue.

Implantação