IoT Dashboard

Table of Contents

Overview
- Built With
Getting Started
- Requirements
- Installation
Contributing
Team
License

Overview

Nowadays IoT is one of the fastest growing industries, we impersonate a company selling IoT sensors and we provide an online Dashboard for: user registration, data collection and visualization, device registration, management and monitoring. We charge our users on the basis of data usage.

Built With

Getting Started

Requirements

Environment

You can define project variables changing the .env file. This file is read by docker-compose to execute the services defined in docker-compose.yml.

Build, Run, Clean

Build and run the project: make start, to run on background use make start-d
Stop: make stop or make kill
See logs (useful if running on background): make logs
Clean projects (deleting docker images too): make purge

Database

All postgres data is contained in database-postgres/data folder.

For more information refer to: https://hub.docker.com/_/postgres

Connect to database

Run make open-db to open a psql terminal (useful to inspect the database or run raw SQL commands).

Populate database

In order to populate the database with some fake data, run make populate-db.

The SQL script that will be executed to populate the database can be found in database-postgres/scripts/data.sql.

Clear database

Run sudo make delete-db to delete all postgres data in order to start with a fresh new database.

Frontend

To install the necessary packages, in the frontend/ directory run:

sudo rm package-lock.json
sudo npm install or sudo yarn install

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.