/fluxo-positivo-api

API do fluxo positivo

Primary LanguageJavaScript

🩸 API Fluxo Positivo 🩸

🛠️ Ferramentas Utilizadas

📚 Bibliotecas e Ferramentas Complementares

⚙️ Configuração da Base de Dados

  1. Crie uma conta Free no Mongo Atlas.
  2. Crie um novo banco de dados com o nome que desejar.
  3. Crie o arquivo .env na raiz do projeto seguindo o exemplo do .env.example.
  4. Nome e senha do CLUSTER são encontrados no seu usuário do banco criado no MongoDB, eles serão usados no arquivo .env em CLUSTER_NAME e CLUSTER_PASSWORD. Dentro do Mongo Atlas é possível acessar SECURITY > Database access > Database users e obter seu usuário, caso não lembre a senha crie um outro com funções de admin para preencher CLUSTER_NAME e CLUSTER_PASSWORD do arquivo .env.

▶️ Como Executar o Projeto

  1. Clone este repositório em sua máquina.
  2. Navegue até a pasta do projeto e execute npm install para instalar as dependências.
  3. Configure a base de dados.
  4. Execute npm run start para iniciar o servidor.

🧪 Testando o Sistema

Para testar o sistema, utilize qualquer cliente HTTP de sua escolha (como Postman ou cURL) e faça requisições para http://localhost:3001.

👥 Equipe do Projeto

Este projeto foi desenvolvido pela equipe de alunos da UTFPR do Grupo 10.

  • Victor Manoel Degaspari
  • Guilherme Francisco Goveia Barros
  • Guilherme Rocha Bastos
  • Paulo Rogério de Pinho
  • Caio Eike Honda Tacahashi

🎯 Objetivo do Sistema

Este sistema foi desenvolvido para ajudar no controle de estoque de absorventes.

🚀 Funcionalidades Desenvolvidas

  1. Funcionalidades CRUDS de estoque, produto, marca, doador/parceiro e perfil
  2. Segurança de rotas com JWT utilizando sessões
  3. Tratativas de erros
  4. Modelagem dos dados

📋 Roteiro para Testar o Sistema

Para testar o sistema, siga estas etapas:

  1. Crie uma conta
  2. Crie um produto, caso tenha uma marca ou doador/parceiro adicione-os
  3. Finalmente, crie um estoque com o produto desejado
  4. Se desejar edite/exclua os produtos, estoques, marcas ou doadores

🔐 Contas de Acesso Padrão

A seguinte conta pode ser usadas para acessar o sistema em produção (https://fluxo-positivo.vercel.app/):