Plannable & Extensively Testable Bateryless Energy Harvesting Sensor Nodes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
crunch c5430d6659 feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
plaeto-backend feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
plaeto-frontend feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
MongoDB Fixture feat: added example data for MongoDB import 7 months ago
README.md feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
docker-compose.png feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
docker-compose.yml feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
plaeto.png feat: added docker compose file, single dockerfiles for each component, graphviz architecture diagram, new readme, screenshot of web client, removed abstract 6 months ago
user_stories.md fix: corrected requirements and explained absence of some features 7 months ago

README.md

PLAETO

PLAETO web client

Preface

Since this project was developed in the context of a past bachelor thesis, it will not be developed any further. Feel free to fork and ask questions.

Contact/Inquiries: dennis@reinkober.it

Introduction

“How could they see anything but the shadows if they were never allowed to move their heads?”

This repository contains the source for an implementation of a bachelor's thesis at the NES chair of the Duisburg-Essen University.

The repository's name is inspired from the parent project SOCRAETES, which provides an API for benchmarking bateryless sensor node energy harvesting data as well as relevant environmental parameters.

Structure

There are two main directories that divide the structure of this project:

  • plaeto_frontend: Vue App for user interaction, graphs and human-readable analysis
  • plaeto_backend: Django Backend service for management and API access of relevant data

Installation

To run this project, you need to either have Docker Desktop (Windows & Mac) installed or Docker and Docker Compose in case you're a Linux user.

In order to ease installation, I prepared a docker compose file, which can be spun up by using only one command. The respective PLAETO system component images are built via Dockerfiles, excluding mongodb and mongo-express, which are ready-to-use images.

  1. If you haven't already, install either Docker Desktop (Windows & Mac) or Docker and Docker Compose (Linux)
  2. Run docker-compose up in the same directory as this README. This will spin up the PLAETO system, including the web client, REST API, MongoDB and the socket server
  3. Visit localhost:8081 and create a new database called plaeto
  4. Inside this database, create a new collection called projects
  5. Select the newly created collection and import the file in this README's directory called MongoDB Fixture for sample data

Note: There may be some inconsistencies concerning persisted storage (see "Caveats") as well as running Compose Files using Docker on Windows/Mac. This is due to these platforms utilizing Docker Desktop. In that case, you would have to deal with it yourself.

Development Procedure

In order to enable organized development, the whole process will be described in User Stories that are distributed across multiple milestones. These milestones are comparable to Sprints from the SCRUM methodology. The aforementioned User Stories will be noted in and accessible from separate document in this git repository.

Documents