anindyamitra15 / Aguamenti-backend

Backend framework to support the IoT implementation of an Automated Home Water Management System

Aguamenti-backend

Aguamenti Backend

Backend framework to support the IoT implementation of an Automated Home Water Management System
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

To do

(back to top)

Built With

• JavaScript

(back to top)

Getting Started

• Setting up node-js: Download and Install the latest node-js from their website

  npm i # installs all the packages from package.json
  

• Running the server

  npm run dev # starts the ts server in development environment with auto restart on code update
  

  npm build # compiles ts server code to js server
  npm start # starts the js server in production environment
  

(back to top)

Features

• Express HTTP REST API for authentication and configuration
• Socket IO 4.x server for device side updates
• Token verification middlewares for both REST and Socket services, ensuring a secure IoT channel
• Mongoose ODM for accessing Mongo DB - a popular and secure NoSQL database

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

License

Distributed for fair usage under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Repo Owner - Anindya Mitra

Project Link: https://github.com/anindyamitra15/Aguamenti-backend

(back to top)

Acknowledgments

to do

(back to top)