- Rodando o projeto na sua máquina
- Configuração do MongoDB
- Relacionando sua conexão do MongoDB ao projeto
- Documentação da API com Swagger UI
- Como contribuir
- git clone https://github.com/pedroluiznogueira/sps-react.git
- Abra o projeto clonado em sua IDE/Editor de texto de preferência
- Abra a pasta do projeto no terminal
- Digite "npm install" e aperte enter
- Digite "node src/index.js" (se perguntado se deseja rodar o projeto em outra porta sem ser a 3000 digite Y)
-> Este projeto está configurado para persistir localmente em uma conexão com o MongoDB
-> Caso precise instalar ele na sua máquina local acesse:
- Instalação do MongoDB
- Instalação do ROBO 3T (interface gráfica para o MongoDB, similar ao Workbench para o MySQL)
-> Rodando o MongoDB no windows:
- Abra o terminal e acesse a pasta C:\Program Files\MongoDB\Server\5.0\bin "5.0" refere-se à versão que você tem instalada
- Digite mongo e aperte enter
-> Uma conexão será criada e aberta para o MongoDB
-> Sua conexão aperecerá com algo deste tipo: mongodb://127.0.0.1:27017
-> Conectando o Robo 3t com seu Serviço do MongoDB
- Abra o Robo 3T
- Crie uma conexão, usando o caminho que o Mongo gerou ácima "mongodb://127.0.0.1:27017"
- Em adress coloque o que aparece para você em: 127.0.0.1
- Posteriormente ao ":" coloque a porta que aparece para você: 27017 (Provavelmente é a mesma pois é a padrão do Mongo)
-> Abra a pasta src/database
-> Em index.js dentro de database
-> Altere a linha 3 com a sua conexão
-> No final segue o nome do banco local que deseja criar
-> Após rodar a aplicação, acesse: localhost:3000/api-docs
-> Lá você encontrará o mapeamento de todos os end-points da API
-> A descriçaõ e detalhes da documentação da API no swagger não está finalizada
-> As informações necessárias para uso e entendimento da API já estão contidas