OPEN CRUD API
API pública para cadastro de usuários para ser usada em testes.
Ajustes e melhorias
O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:
- Rota para autenticação
- Rota para "Esqueci minha senha"
💻
Pré-requisitos
Antes de começar, verifique se você atendeu aos seguintes requisitos:
- Você instalou a versão mais recente de
Node.js
- Você instalou a versão mais recente de
Mongodb
- Você tem uma máquina
<Windows / Linux / Mac>
.
🚀
Instalando open-crud-api
Para instalar as dependências:
npm install
Configure as variáveis de ambiente:
Para isso, crie um arquivo na raiz chamado
.env
DATABASE_URL="mongodb+srv://localhost:27017/crud-api?retryWrites=true&w=majority"
JWT_KEY=chave_para_criptografia_do_token
☕
Usando open-crud-api
Para usar open-crud-api em modo de desenvolvimanto, execute o comando:
npm run start:dev
Para usar open-crud-api em modo de pré-produção, execute o comando:
npm run start
Adicione comandos de execução e exemplos que você acha que os usuários acharão úteis. Fornece uma referência de opções para pontos de bônus!
📫
Contribuindo para open-crud-api
- Faça o fork desse repositório.
- Crie um branch:
git checkout -b <nome_branch>
. - Faça suas alterações e confirme-as:
git commit -m '<mensagem_commit>'
- Envie para o branch original:
git push origin <nome_do_projeto> / <local>
- Crie a solicitação de pull.
Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.
🤝
Colaboradores
Agradecemos às seguintes pessoas que contribuíram para este projeto:
Pedro Henrique |