joseaugustojasfarias/soulpet-back

SoulPet - BackEnd

A parte backend do site SoulPet é responsável por gerenciar todas as informações referentes a clientes, pets, produtos, serviços e pedidos, fornecendo uma estrutura sólida e confiável para o site. Com rotas específicas para cada recurso, o backend possibilita consultas, edições e exclusões de forma eficiente, garantindo a integridade dos dados e a segurança das informações. Além disso, o dashboard do site é alimentado pelas estatísticas geradas pelo backend, permitindo uma visualização completa e detalhada do desempenho do petshop. Com uma arquitetura bem definida com segurança e um desenvolvimento cuidadoso, o backend do site de petshop oferece uma experiência agradável e intuitiva para gerenciar todas as operações relacionadas ao petshop de forma eficiente e confiável.

🚀 Começando

Com estas instruções, você será capaz de obter uma cópia do projeto em execução em sua máquina local para fins de desenvolvimento e teste.

Pré-requisitos;

Antes de prosseguir, certifique-se de ter instalado o seguinte:

1. GitBash - para clonar o repositório;

2. Banco de dados MySQL;

3. Banco de dados MongoDB configurado;

4. PostMan para testes localhost(Opcional);

Clonando o repositório e instalação;

Para clonar o repositório do SoulPet-BackEnd, siga os passos abaixo:

1 - Abra o GitBash.

2 - Crie uma pasta em sua localização de preferência.

3 - Acesse a pasta usando o comando cd no GitBash.

4 - Execute o seguinte comando para clonar o repositório:

[git clone https://github.com/JoseAugustoJasfarias/soulpet-back]

5 - Depois de clonar o repositório, instale as dependências do projeto:

[npm install]

6 - Faça a configuração do .Env (Use o .env.exemple como base):

7 - Inicie o servidor local:

[npm start]

• Você pode adicionar dados utilizando as funções disponíveis no projeto rodando.

📦 Implantação

Tenha o Front-End do projeto e adicione o projeto de em um local de hospodagem 24h com banco de dados, adquira um dominio e poderá deixar 100% disponivel para clientes.

🛠️ Construído com

• Node.js - Gerente de Dependência e framawork

✨ Dependências usadas

• cors: "^2.8.5",
• dotenv: "^16.0.3",
• express: "^4.18.2",
• express-validator: "^7.0.1",
• joi: "^17.9.2",
• moment-timezone: "^0.5.43",
• mongoose: "^7.1.0",
• morgan: "^1.10.0",
• mysql2: "^3.2.3",
• nodemon: "^2.0.22",
• sequelize: "^6.31.1"

✒️ Autores

Mencione todos aqueles que ajudaram a levantar o projeto desde o seu início

• Lucas Damasceno - Desenvolvedor full-stack/documentação - Lucas Damasceno
• Jose Augusto - Desenvolvedor full-stack - José Augusto
• Lais Belo - Desenvolvedora full-stack - Lais Belo
• Victoria Dourado Scapini - Desenvolvedora full-stack - Victoria Scapini
• Lucas Velsch - Desenvolvedora full-stack - Lucas Velsch

soulpet-back's Issues

[BE-19] Criar recurso GET para listagem de Pedidos

Crie quatro rotas GET para listagem de pedidos.

• /pedidos
  Esta rota deve listar todos os pedidos.
• /pedidos/:id
  Esta rota deve mostrar os dados do pedido de acordo com o id fornecido. O pedido retornado deve incluir os valores do produto e do cliente relacionado.
• /pedidos/produtos/:id
  Esta rota deve mostrar os dados do pedido de acordo com o id do produto fornecido. O pedido retornado deve incluir os valores do cliente relacionado.
• /pedidos/clientes/:id
  Esta rota deve mostrar os dados do pedido de acordo com o id do cliente fornecido. O pedido retornado deve incluir os valores do produto relacionado.

Depende de: BE-18

[BE-6] Criar recurso GET para listar os pets dos Clientes

Crie uma rota GET que lista os pets que pertencem a um Cliente.

• /clientes/:clienteId/pets
  Esta rota deve responder com todos os pets associados a um Cliente especificado pelo clienteId.

[BE-3] Criar recurso POST para inserção de Produtos

Crie uma rota POST para inserir novos produtos.

• /produtos
  Todos os dados vindos do body devem ser checados para garantir que dados inválidos não entrem no banco de dados. Exemplo:
  • Checar se a categoria é uma das predefinidas (Higiene, Brinquedos, Conforto);
  • Se a data de desconto é futura;
  • Se o desconto está entre 0 e 100 (percentual);
  • Etc.

Depende de: BE-1

[BE-14] Criar recurso GET para listagem de Agendamentos

Crie uma rota GET para listar todos os agendamentos realizados no sistema.

Depende de: BE-9

[SPT-6] Crie um esquema de logs com MongoDB

Crie um recurso com a biblioteca morgan que possibilite enviar as informações de requisição de log para o banco do MongoDB.

[BE-8] Criar model de Serviço

Crie um novo model para a aplicação backend. Suas colunas são:

• nome (obrigatório);
• preço (obrigatório);

O relacionamento entre Pet-Serviço é N:N. Deve ser implementado um segundo model que representa a tabela junção (Agendamento) entre as duas entidades.

Dica: Veja a seção Implementation da documentação.

[BE-17] Criar recurso DELETE para remoção de Agendamentos

Crie uma rota DELETE que remove um agendamento do sistema.

• /agendamento/:id
  Remova o agendamento com o respectivo id.
• /servicos/all
  Remova todos os agendamentos do banco de dados.

Depende de: BE-9

[BE-22] Criar recurso DELETE para remoção de Produtos

Crie três rotas DELETE para remover pedidos.

• /pedidos/:id
  Remova o pedido com o respectivo id.
• /pedidos/clientes/:id
  Remova todos os pedidos pelo respectivo id do cliente.
• /pedidos/produtos/:id
  Remova todos os pedidos pelo respectivo id do produto.

Depende de: BE-18

[BE-10] Criar recurso GET para listagem de Serviços

Crie duas rotas GET para listagem de serviços.

• /servicos
  Esta rota deve listar todos os serviços. Também deve aceitar uma query que filtra por status ou data
• /servicos/:id
  Esta rota deve mostrar os dados do serviço de acordo com o id fornecido.

Depende de: BE-8

[BE-20] Criar recurso POST para inserção de Pedidos

Crie uma rota POST para inserir múltiplos pedidos.

• /pedidos
  A requisição deve receber em seu corpo um vetor de pedidos, que devem ser inseridos.
  Todos os campos do Body devem ser checados e validados antes de realizar inserção.

Depende de: BE-18

Dica: bulkCreate

[BE-5] Criar recurso DELETE para remoção de Produtos

Crie duas rotas DELETE para remover produtos.

• /produtos/:id
  Remova o produto com o respectivo id.
• /produtos/all
  Remova todos os produtos do banco de dados.

Depende de: BE-1

[BE-16] Criar recurso PUT para atualização de Agendamentos

Crie uma rota PUT para atualizar um agendamento, é necessário o id do pet e também o id do serviço escolhido. Bem como as demais propriedades do model de agendamento.

Depende de: BE-9

[BE-12] Criar recurso PUT para atualização de Serviços

Crie uma rota PUT para atualizar serviços existentes.

• /servicos/:id
  Todos os campos do Body devem ser checados e validados antes de realizar atualização.

Depende de: BE-8

[BE-7] Criar recurso GET para mostrar apenas o Endereço dos Clientes

Crie uma rota GET que mostra o endereço que pertence a um Cliente.

• /clientes/:clienteId/endereco
  Esta rota deve responder com os dados do endereço do Cliente especificado pelo clienteId.

[SPT-12] Melhorias de segurança e desempenho do Backend

Aplique as boas práticas de segurança descritas na documentação do express, bem como boas práticas de desempenho.

• Melhores Práticas de Segurança
• Melhores Práticas de Desempenho
• How to implement health check in Node.js

O desenvolvedor deve dar manutenção periódica a esta task para garantir ao final que ela é consistente.

[BE-2] Criar recurso GET para listagem de Produtos

Crie duas rotas GET para listagem de produtos.

• /produtos
  Esta rota deve listar todos os produtos. Caso seja enviado na rota uma query como /produtos?nome= ou /produtos?categoria=, os dados devem ser fitrados para que apareçam apenas produtos de acordo com a busca.
• /produtos/:id
  Esta rota deve mostrar os dados do produto de acordo com o id fornecido.

Depende de: BE-1

[BE-11] Criar recurso POST para inserção de Serviços

Crie uma rota POST para inserir novos serviços.

• /servicos
  Todos os campos do Body devem ser checados e validados antes de realizar inserção.

Depende de: BE-8

[SPT-3] Criar esquemas de validação do corpo da requisição

Validar com uso da biblioteca Joi os corpos de requisição das rotas da aplicação para impedir que dados inválidos sejam inseridos no banco de dados. Aplicar validação em todas as inserções e atualizações de dados, responder ao cliente com 400 em caso de dados fornecidos inválidos. É necessário que as mensagens de erro sejam traduzidas para o português usando a configuração messages da função validate e que o error.details seja tratado para mostrar apenas um array com as mensagens de erro.

O desenvolvedor deve dar manutenção periódica a esta task para garantir ao final que o tratamento é consistente.

[BE-1] Criar model de Produto

Crie um novo model para a aplicação backend, ele representa um produto e possui as seguintes colunas:

• nome (obrigatório)
• preço (obrigatório)
• descricao (obrigatório, 150 caracteres)
• desconto (obrigatório)
• dataDesconto (obrigatório)
• categoria (obrigatório)

[BE-21] Criar recurso PUT para atualização de Pedidos

Crie uma rota PUT para atualizar pedidos existentes.

• /pedidos/:id
  Todos os campos do Body devem ser checados e validados antes de realizar atualização.

Depende de: BE-18

[BE-15] Criar recurso POST para inserção de Agendamentos

Crie uma rota POST para inserir um novo agendamento, é necessário o id do pet e também o id do serviço escolhido. Bem como as demais propriedades do model de agendamento.

Depende de: BE-9

[BE-4] Criar recurso PUT para atualização de Produtos

Crie uma rota PUT para atualizar produtos existentes.

• /produtos/:id
  Todos os dados vindos do body devem ser checados para garantir que dados inválidos não entrem no banco de dados. Exemplo:
  • Checar se a categoria é uma das predefinidas (Higiene, Brinquedos, Conforto);
  • Se a data de desconto é futura;
  • Se o desconto está entre 0 e 100 (percentual);
  • Etc.

Depende de: BE-1

[BE-18] Criar model de Pedido

Crie um novo model para a aplicação backend. Suas colunas são:

• codigo (chave primária, deve ser um UID);
• quantidade (obrigatório);

O relacionamento entre Cliente-Pedido é 1:N. O relacionamento entre Produto-Pedido é 1:N.

Dica:

• Veja a seção Implementation da documentação.
• UUID.

[BE-9] Criar model de junção Pet-Serviço (Agendamento)

Este model deve ser implementado após o model de Serviço para complementar. Pode nomear este model de junção como Agendamento. Além dos campos de chave estrangeira, deve haver:

• dataAgendada (data prevista para realizar o serviço);
• realizada (booleano);

Depende de: BE-8.

Dica: Veja a seção Implementation da documentação.

[SPT-11] Triggers de banco de dados MySQL

Implemente triggers do MySQL capazes de realizar backup de todas as tabelas do sistema, sempre que é feito alguma remoção de dados de alguma tabela.

O desenvolvedor deve dar manutenção periódica a esta task para garantir ao final que ela é consistente.

[SPT-4] Criar esquema de popular banco de dados com dados fictícios

Crie uma variável de ambiente DB_FORCE que pode ser true ou false. Use ela para configurar o sync force do sequelize, e caso seja true, use um esquema para preencher o banco com dados fictícios. Devem haver:

• 2 clientes;
• 3 pets (dois do primeiro cliente e um do segundo);
• Caso haja outras entidades no projeto, cuidar para que elas também sejam populadas;

O desenvolvedor deve dar manutenção periódica a esta task para garantir ao final que o tratamento é consistente.

[BE-13] Criar recurso DELETE para remoção de Serviços

Crie duas rotas DELETE para remover serviços.

• /servicos/:id
  Remova o serviço com o respectivo id.
• /servicos/all
  Remova todos os serviços do banco de dados.

Depende de: BE-8

[SPT-2] Criar implementação de mensagem de erro de resposta

No backend, nas tentativas de executar queries do banco de dados utilizamos try-catch, porém o código de status 500 não é o mais preciso para as diversas situações que podem acontecer. Trate o objeto err no catch para responder ao cliente com mensagens e códigos de status mais preciso sobre o erro ocorrido (todas as rotas com try-catch devem ter esse tratamento). As respostas de erro devem ter:

• Código de status;
• Mensagem em português sobre o erro ocorrido;
• Timestamp da requisição;
• Rota em que ocorreu o erro.

O desenvolvedor deve dar manutenção periódica a esta task para garantir ao final que o tratamento é consistente.