TCC - API

Voltar   |   Features   |   Requirements   |   Starting   |   Testing   |   License   |   Author

🎯 About

Implementação de uma API como parte do trabalho de conclusão de curso.

✨ Features

✔️ RESTful API;
✔️ Configuração automática;

✅ Requirements

Antes dos procedimentos em 🏁 Starting, esta aplicação requer as tecnologias:

• Node.js
• MongoDB
• NPM

🏁 Starting

# NPM
$ npm install

# iniciar execução local
$ npm run local_debugging

# iniciar execução em produção
$ npm run app

Após executar, a API é inicializada na porta 8080, visto em app.js

A aplicação faz uso de APIs de terceiros, sendo estas Unsplash e PositionStack. É necessário obter credenciais próprias e válidas para estes.

É necessário estabelecer as seguintes variáveis de ambiente para a aplicação:

• MONGODB_CLOUD_ADDR
  Endereço de nuvem do banco de dados mongodb.
  Ignorar caso o uso seja local.

• MONGODB_USERNAME

• MONGODB_PW
  Definir username/password do banco de dados
  Ignorar caso o banco utilize a config. de não-restrição.

• NODE_ENV
  development = Local, em desenvolvimento
  production = em nuvem / remoto / release do sistema

• UNSPLASH_KEY
  Definir chave da API Unsplash.

• POSITIONSTACK
  Definir chave da API PositionStack.

• JWT_KEY
  Chave de geração dos tokens JWT
  ( Pode ser qualquer string >= 16 caracteres )

📝 License

This project is under license from GPL. For more details, see the LICENSE file.

Made with ❤️ by Draylon

 

Back to top