Guga-Santos / ESG_STAMPS_APP_BACKEND

Respositório dedicado ao backend de app experimental

Selos_APP BACKEND

1 - Clone o Projeto

2 - Entre na pasta clonada

* É necessário ter o Docker instalado.

- Talvez se faça necessário executar NPM INSTALL antes dos passos a seguir:

Para iniciar o projeto, digite:

  npm run docker-build

Após a construção, abra outro terminar e digite:

  npm run docker-run

Após isso, dentro do terminal iterativo criado, digite:

  npm install

Apartir daqui, todos os comandos devem ser executados dentro do terminal iterativo.

---

---

---

DB entities:

*Existem três entidades que NÃO se relacionam diretamente (mongoDB).

*Coleção Users adicionada de forma independente apenas para validação de requisições.

---

---

Tecnologias utilizadas:

Banco:

• MongoDB e Mongoose como ODM.

API:

• Node.JS com Typescript, com gerenciamento via Express.

Validações:

• Zod e JWT.

Testes:

• Mocha, Chai e Sinon, com istanbul(nyc) como coverage.

---

---

ROTAS:

COMPANY:

GET /companies:

GET /company/:id :

POST /company :

PUT /company/:id :

DELETE /company/:id :

STAMPS:

GET /stamps:

GET /stamp/:id :

POST /stamp :

PUT /stamp/:id :

DELETE /stamp/:id :

CATEGORY:

GET /categories:

GET /category/:id :

POST /category :

PUT /category/:id :

DELETE /category/:id :

---

---

Tests:

Ainda Falta:

• Implementar JWT nas rotas para autenticação do usuário.
  • Jwt
  • middleware
  • Implementar na rota
• Testes unitários
  • UserModel
  • UserService
  • CompanyService
  • CategoryService
  • StampService
  • UserController
  • CompanyController
  • CategoryController
  • StampController
• Construir Seeds para popular banco no build.
  • Company
  • User
  • Category
  • Stamps