Skip to content

Web app for displaying the readings from wireless sensors

Notifications You must be signed in to change notification settings

apata/sensor-panel-web

Repository files navigation

Sensor Panel

Sensor panel app high-level concept diagram

Sensor Panel web app (https://sensor-panel.web.app) is a proof of concept app to monitor data sent by a network of Internet of Things (IoT) sensors (currently simulated with a Google Cloud scheduled function that runs every 3 minutes).

System architectural concept

  • simple cloud deployment pipelines (Firebase)
    • single repository for backend and frontend
  • shared Typescript models between backend and frontend to simplify iterative changes and API changes
    • backend as lambda function
  • cloud data store, not database
    • self-maintaining with scheduled functions

My considerations for choosing this platform

Technologies

Front-end

  • Typescript
  • React single page app (bootstrapped with create-react-app)
  • D3.js data visualisation library
  • Located in repository root folder .

Back-end

  • Typescript
  • Express "server" as Firebase Cloud Function https endpoint
  • Located in folder ./functions

Data persistence

  • Firebase Firestore

Running locally

There are two steps to run the project locally. Both steps have two options to choose from.

Option A Option B
Step 1: Dependencies Docker container Linux / MacOS native
Step 2: Environment Development mode Production mode

Step 1A: Start the development Docker container

The development environment is containerised for convenience (see Dockerfile and docker-compose). Dockerfile is based on https://github.com/AndreySenov/firebase-tools-docker image, but with non-alpine Linux so the shell commands would execute faster in the container.

Start the development container with these commands:

  • docker-compose up -d
  • docker-compose exec emulators bash
  • In the opened bash terminal, continue with the development mode or production mode commands.

Step 1B: Install the dependencies manually (Linux / MacOS)

  • Install Node (version 12, specifically needed for Cloud Functions)
  • Install NPM package firebase-tools globally (for version, please see VERSION build argument in docker-compose file)
  • Install a Java Runtime Environment (for version, see Dockerfile)
  • Run firebase setup:emulators:firestore to install emulators
  • In your terminal, continue with the development mode or production mode commands.

Step 2A: Run in development mode

Run the following two command sets to get started

FE

  • npm install to install the depedencies
  • npm start to start webpack development server
  • navigate to http://localhost:3000 to see the FE

BE

Step 2B: Run in production mode

The production command set builds the FE and BE production versions and emulates the whole environment (FE, BE, Firestore) with some prefilled data in Firestore.

API info

POST /api/sink

Accepts application/json in format as defined here.

About

Web app for displaying the readings from wireless sensors

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published