Skip to content

it is a back end software, responsible for providing mined data to fronend in real time

License

Notifications You must be signed in to change notification settings

AUTTY-BR/autty-api

Repository files navigation

DATAMOTOR

Backend para sistema de telemetria com as seguintes funçoes:

  • cliente:
    • servir dados em tempo real;
    • socket;
    • gerar relatórios;
    • enviar sms;
    • gerar alarmes;
    • autenticar.
  • server
    • receber, armazenar e processar dados;
    • enviar configurações;
    • enviar comandos;

English Version

Uso em desenvolvimento:

  1. Clone o repositório
  2. Execute o comando npm install
  3. Adicionar variveis de ambiente em ./config
  4. Execute uma base mongoose ou utilize o comando npm run base
  5. Execute o comando npm run dev

para testes :

  1. Para testes unitarios npm run tests:unit
  2. Para testes funcionais npm run tests:functional

Pipelines git; Docker;

O servidor roda por padrão na porta 4000, mas você pode alterar isso exportando uma variável PORT ao executar o comando start: PORT=<porta> npm start.

Você também pode importar a coleção de requests para o seu Postman.

Para documentação de endPoits utilize o Swagger na rota host/docs e por json (openApi3) em src/documents/openapi.json

About

it is a back end software, responsible for providing mined data to fronend in real time

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages