-O que posso realizar com a API
-Lista de end-points, rotas disponíveis, recursos e os parâmetros necessários
-Integrantes da realização do projeto SoulPet
A SoulPet é uma aplicação para donos de petshop, é uma solução tecnológica que possibilita que as informações sobre os clientes, pets, produtos, serviços, vendas e outros dados relevantes sejam acessados e gerenciados de forma mais eficiente e automatizada.
- Essa API oferece diversos recursos, como por exemplo:
- A criação de cadastros de clientes e seus respectivos pets.
- A consulta de produtos disponíveis em estoque, e inserção ou remoção de novos produtos.
- a realização de agendamentos de serviços
- Pedidos feitos pelo site. Entre outros recursos.
Ao abrir o Servidor/Site você encontrará a página Home da nossa aplicação. Dentro da página home podemos encontrar as seguintes rotas no nosso Backend:
- Inicio (http://localhost:3001)
- Produtos (http://localhost:3001/produto)
- Clientes (http://localhost:3001/clientes)
- Pets (http://localhost:3001/pets)
- Serviços (http://localhost:3001/Servicos)
- Pedidos (http://localhost:3001/pedido)
Para rota Produtos
criamos um recurso POST para a inserção de produtos novos. Criamos também o recurso GET
para listagem de produtos e um DELETE
para remoção dos mesmos.
Dentro desse recurso, mantivemos as seguintes categorias: "nome" ,"preco",
"descricao","desconto", "data de desconto", e "categoria".
Com a rota http://localhost:3001/produto/novo.
E para atualizar o produto criamos uma recurso PUT
. A rota será: http://localhost:3001/produtos/editar/.
Para rota Clientes
, nós também criamos um POST
para a funções de adicionar, um DELETE
para remover ou PUT
para atualizar os clientes. Criamos também o recurso GET
para listagem de produtos.
Que são as seguintes rotas:
Atualizar: http://localhost:3001/clientes/editar/ (Nos devolver o objeto atualizado, ou uma mensagem de erro caso não seja encontrado.)
Adicionar: http://localhost:3001/clientes/novo (Nos devolve um novo objeto inserido, ou uma mensagem de erro dependendo dos criterios atingidos.)
Para rota Pets
, nós também temos as funções de adicionar POST
, remover DELETE
ou atualizar PUT
os Pets. Criamos também o recurso GET
para listagem de produtos.
Que são as seguintes rotas:
Atualizar: http://localhost:3001/pets/editar/ (Nos devolver o objeto atualizado, ou uma mensagem de erro caso não seja encontrado.)
Adicionar: http://localhost:3001/pets/novo (Nos devolve um novo objeto inserido, ou uma mensagem de erro dependendo dos criterios atingidos.)
Para rota Serviços
, como nas outras também temos as funções de adicionar POST
, remover DELETE
ou atualizar PUT
os serviços. Criamos também o recurso GET
para listagem de serviços.
Que são as seguintes rotas:
Atualizar: http://localhost:3001/servicos/editar/ (Nos devolver o objeto atualizado, ou uma mensagem de erro caso não seja encontrado.)
Adicionar: http://localhost:3001/servicos/novo (Nos devolve um novo objeto inserido, ou uma mensagem de erro dependendo dos criterios atingidos.)
Para rota Pedidos
, nós também temos as funções de adicionar POST
, remover DELETE
ou atualizar PUT
os serviços. Criamos também o recurso GET
para listagem de produtos.
Que são as seguintes rotas:
Atualizar: http://localhost:3001/pedidos/editar/ (Nos devolver o objeto atualizado, ou uma mensagem de erro caso não seja encontrado.)
Adicionar: http://localhost:3001/pedidos/novo (Nos devolve um novo objeto inserido, ou uma mensagem de erro dependendo dos criterios atingidos.)
Também implementamos a função de buscar pelo Id
do cliente na Search bar. E buscar por todos os pedidos.
O projeto foi realizado com uso de:
Node.js
, Express
, Sequelize
, MySQL
, Morgan
, Dotenv
, NodeMon
, e Joi
.
Para rodar o produto é necessário que você tenha instalados:
MySQl, git, Node js, VSCODE, Joi.
Realizar um Git Clone
no respositório. E Instalar as dependências do projeto que são: @testing-library/jest-dom, @testing-library/react, @testing-library/user-event, axios, bootstrap, bootstrap-icons, react, react-bootstrap, react-dom, react-hook-form, react-hot-toast, react-router-dom, react-scripts, web-vitals, yup e nodemon. Para instalar as dependências basta abrir o terminal CRTL+ J e digitando dentro do terminal: Npm install
. Configurar o arquivo .env
.
E configurar o script start
no package.json: Da seguinte maneira: "start": "nodemon ./index.js".
Após isso você pode abrir seu terminal pressionando CRTL+ J.
E digitando dentro do terminal: npm start
, tanto na parte de front, quanto na parte de back para que em conjunto as duas funcionem junto e você seja capaz de adicionar, atualizar, remover e utilizar as funcionalidades do site sem mais problemas.
Entre em contato com o suporte: Se você tiver alguma dúvida ou problema ao utilizar o site, entre em contato conosco!
- João Lima - [GitHub] (https://github.com/eujoaolima), [LinkedIn] (https://www.linkedin.com/in/eujoaolima/)
- Raissa Kimberly - [GitHub] (https://github.com/raissakimberly), [LinkedIn] (https://www.linkedin.com/in/raissa-kimberly-12b103246//)
- Raphael Faria - [GitHub] (https://github.com/Raphaeldev84), [LinkedIn] (https://www.linkedin.com/in/raphael-gomes-faria-35b544239/)
- Laura Xavier - [GitHub] (https://github.com/lauraxavier), [LinkedIn] (https://www.linkedin.com/in/laura-xavier-75b9a0243/)
- João Pedro Fernandes - [GitHub] (https://github.com/Paahxp123), [LinkedIn] (https://www.linkedin.com/in/jo%C3%A3o-pedro-fernandes-b0b107137)
Agradecimentos a SoulCode
e aos professores Gabriel & Almir
por toda paciência e dedicação para nos ensinar!