API Rest para avaliação de restaurantes

📖 Descrição

Esse é o projeto de uma API Rest para avaliação de restaurantes. Ela armazena o cadastro de clientes e restaurantes, em seguida os clientes poderão avaliá-los. Essa API foi desenvolvida como desafio proposto para a primeira turma do OneBitCode Black.

🛠️ Funcionalidades

• Armazenar os dados do restaurante
• Armazenar os dados dos clientes
• Os clientes podem avaliar os restaurantes com de 1 a 5 estrelas (⭐⭐⭐⭐⭐)
• Clientes não devem ser capazes de avaliar o mesmo restaurante mais de uma vez
• Obter todas as avaliações que um cliente já fez e uma média dessas avaliações
• Obter todas as avaliações de um restaurante e uma média de estrelas
• Obter os 5 restaurantes mais bem avaliados

📡 Tecnologias utilizadas

⏳ Inicialização

Esse projeto foi desenvolvido em ambiente Linux, utilizando o Ubuntu 22 e as tecnologias citadas anteriormente. Caso você utilize outro sistema operacional, a configuração inicial do projeto pode ser um pouco diferente, por isso sugerimos que você acesse os links indicados abaixo:

A preparação do ambiente consiste em instalar as tecnologias citadas anteriormente de acordo com seu sistema operacional.

Para instalar o Node.js, acesse: https://nodejs.org/pt-br/download/package-manager/

O Typescript também precisa ser configurado, utilize essa página como referência: https://www.typescriptlang.org/download

O sequelize deve ser configurado conforme orientações da documentação oficial: https://sequelize.org/docs/v6/getting-started/ Para utilizar o express, ele também deve ser instalado: https://expressjs.com/pt-br/starter/installing.html

🔮 Implementações futuras

1. Implementar possibilidade de realizar entregas, incluindo no pedido a informação se ele será entregue ou não.

2. Implementar a possibilidade de o cliente avaliar os entregadores.

3. Implementar autenticação para impedir que os clientes façam as alterações em nome de outros clientes.

🤵🤵‍♀️ Colaboradores

Os colaboradores desse projeto são os Instrutores da OneBitCode: Isaac Pontes (Que propos o desafio e é Responsável pelo desenvolvimento dessa API), Juliana Conde (Que contribuiu após o desenvolvimento do projeto com o arquivo Readme) e Lucas Queiroga (Que também trabalha em melhorias para o projeto). Além de todos os alunos do OneBitCode Black ❤️

🔎 Status do Projeto

📑 Referências

Visite o site da OneBitCode para conhecer os cursos e projetos https://onebitcode.com/lp/

Siga nossa página no instagram: @onebitcode

Se inscreva no nosso canal do YouTube: https://www.youtube.com/c/OneBitCode

Conheça o OneBitCode Black: https://chat.whatsapp.com/LOLzh57CDc81UOguDP0OUN