This repository contains the proof of concept of Antares' alerting and notification IoT system by utilizing MQTT over WebSockets. This backend system is implemented with the following technologies:
Component | Technology |
---|---|
HTTP Server | NestJS |
Websocket Server | Socket.IO |
MQTT Broker | Mosquitto |
Notification Service | Firebase Cloud Messaging |
Mailing Service | Nodemailer |
API Documentation | Swagger |
# clone the repository
$ git clone [email protected]:fzl-22/antares-insight-backend.git
# navigate to the project
$ cd antares-insight-backend
# install dependencies
$ npm install
# development mode
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
# containerized mode
$ docker compose -f docker-compose.[dev|prod].yml up --build
Documentation is generated for every compilation and can be found in http://localhost:3000/api/docs.