Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

[wip] update docs for latest web server deployment #294

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[wip] update docs for latest web server deployment #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,24 @@
Anaerobic Digestion and Pasteurization Latrine (ADPL)
=====================================================

# Anaerobic Digestion and Pasteurization Latrine (ADPL)
Project Overview: http://sanitation.pratt.duke.edu/onsite-treatment

Particle Electron (MCU)
-----------------------
## Particle Electron (MCU)
The active MCU software is in `software/ADPL_electron` using the `v6.2.0` Electron firmware.

Web Server
----------
Live data streaming is avaialble to view at http://adpl.suyash.io .
## Web Server
The web application is responsible for listening to real-time streaming data
from different ADPL stations, saving that data to a database, and making those
data available for inspection and analysis via a RESTful API and dashboard-like
front end. The web server performs several additional functions like
integrating with Twilio to allow for text-based alerts and interaction (with
many features yet to be implemented).

The web application is responsible for listening to real-time streaming data from different ADPL stations, saving that data to a database, and making those data available for inspection and analysis via a RESTful API and dashboard-like front end. The web server performs several additional functions like integrating with Twilio to allow for text-based alerts and interaction (with many features yet to be implemented).
Live data streaming is avaialble to view at http://adpl.suyash.io .

## Setup
To install this web application on a vanilla debian-flavored linux server:
1. Install git: ```sudo apt-get install git```
2. Clone & run Suyash's provision script (a subtree is also available in ``provision/``):

```bash
git clone https://github.com/suyashkumar/provision.git
cd provision
./provision.sh
```
The server is running on an instance of Google Cloud, which you can download
the SDK tolls [here](https://cloud.google.com/sdk/downloads).

**NEED TO UPDATE EVERYTHING ELSE BELOW HERE**
## Run the Application
After provisioning a server as noted above:
1. Clone this repository: `git clone https://github.com/mlp6/ADPL.git`
Expand Down