Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.7 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.7 KB

Argus

Argus is a sensor data monitoring and alerting solution built with MariaDB, Node.js and React. Developed and tested on a Raspberry Pi. Available as a pre-built Docker image from GitHub Package Registry.

Screenshots

Screenshot of login page

Screenshot of application dashboard

Screenshot of a measurement chart

Modules

Server application

Measurement clients

Usage with docker-compose

Consult the documentation of the backend server and the modules you want to use, and create a docker-compose.yml file containing the desired services.

Run the selected services with: docker-compose up -d.

How to setup the development environment

  1. This project requires Node.js and Docker to be installed.
  2. Create a .env file in the root of the repository with the following entries: 
    DATABASE_URL=mysql://root@mariadb/argus
TOKEN_SECRET=<generate_and_put_your_own_long_random_string_here>
USERS=username:password
  3. Initialize the Docker environment: npm run docker:bootstrap
  4. Seed the database: npm run docker:seed
  5. Start the dev servers: npm run docker:up

That's it! Now you can visit http://localhost:3000 and login with username and password.