Live Dashboard

This is a sample project to display live data. The project was built using a PostgreSQL database and an Express.js backend server. The web page was built using Angular and ng2-charts. The communication between the frontend and backend has been handled with a WebSocket connection using the Socket.io library. Tests have been run using Mocha and Chai in the backend, while Karma and Jasmine have been used on the frontend.

Getting Started

Download or checkout the project on your local machine. The whole project has been dockerized so the quickest way to run the project is to use Docker.

Prerequisites

Docker

Installing

Checkout or download the project and run the following command in the folder where you downloaded everything.

docker-compose up

By default the app runs on port 4200, so to use it just type the following address on your browser.

http://localhost:4200

Adding new data

On first start the database is already populated with some sample data by an initialization script. However, it is possible to add new data and see it appear live on the dashboard. In order to add and see live data you can POST new info to the backend at the following endpoint.

POST http://localhost:3000/api/download

Example data:

{
	"data": {
		"latitude": "-0.127758", 
		"longitude": "40.507351", 
		"appId": "APP_IOS", 
		"downloadedAt": "11/11/2019"	
	}
}

Built With

• Angular - Frontend
• Express.js - Backend
• PostgreSQL - Database
• Socket.io - Socket Communication

License

This project is licensed under the MIT License - see the LICENSE.md file for details