Add README.md

README.md

@@ -0,0 +1,64 @@
+# EVS Notifications System
+Nobody wants their aircon to switch off in the middle of the night when their credit runs out.  
+
+The EVS notification system scrapes your credit balance daily. When your balance falls below a preset threshold, the system notifies you via Telegram bot.
+
+## Architecture
+Click [here](assets/architecture.jpg) for an image of the system architecture.  
+
+All operations involving data is done through individual corresponding APIs.
+
+### Components
+* Postgres database
+* Vue website for dashboard analytics
+* Telegram bot
+
+### APIs
+* CRUD operations for database
+* GET operations only for dashboard
+* Endpoint for fetching balance via web scraping
+* Endpoint for sending one-time messages via Telegram bot
+
+### Daily-run services
+* Scrape all user balances and add to database
+* Retrieve all users to notify and send notifications
+
+## Pre-requisites
+1. Python 3.6+
+1. Either:
+	* Postgres 9.5
+	* Docker
+1. NodeJS
+
+## Deployment
+### Python
+The following components use Python:
+* APIs (Flask)
+* Telegram bot (python-telegram-bot)
+* Daily-run services
+
+All Python-based components have a `requirements.txt` file in their corresponding folder.
+
+### Vue dashboard
+There is a corresponding README in the `dashboard` folder. A static site is bundled using Webpack and used for hosting.
+
+### Postgres
+The database is run from a Docker container. To get a database up and running on your local machine:
+```
+docker pull postgres:9.5
+docker run --rm -d \
+    --name pg-docker \
+    -e POSTGRES_USER=ubuntu \
+    -e POSTGRES_PASSWORD=password \
+    -e POSTGRES_DB=evs \
+    -p 5432:5432 \
+    -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data \
+    postgres:9.5
+```
+
+Afterwards, to connect to the database:
+```
+PGPASSWORD=docker psql -h localhost -U postgres -d evs
+```
+
+For first-time setup, run `\i create_tables.sql` to define database schema.

assets/architecture.drawio

@@ -0,0 +1 @@
+<mxfile modified="2019-06-19T09:11:45.959Z" host="www.draw.io" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.80 Safari/537.36" etag="oMmGu_xdu7RLcLjB1PFZ" version="10.7.7" type="device"><diagram name="Page-1" id="bfe91b75-5d2c-26a0-9c1d-138518896778">7Zttc6o4FMc/jS/bIQkCvmzt053p3emOnb23+2YnQsRskbghVr2ffhMIAoJKfQDdbd9ITkJIzv93YnKwHdSfLB45no6/M48EHWh4iw6660D5B6D8UJZlYgEri8+pp22ZYUB/EW00tHVGPRIVGgrGAkGnRaPLwpC4omDDnLN5sdmIBcWnTrFPSoaBi4Oy9Qf1xDixOtDO7E+E+uP0ycDqJTVD7L77nM1C/bwORKP4L6me4LQvPdFojD02z5nQfQf1OWMiuZos+iRQzk3dltz3sKF2NW5OQlHnhg/xNn69H9rBYzj/Dhc/u4tfoyut1QcOZiSdhhXI/m5HTHYrRy2W2lPWPzOWVlxFsY43soHpTBdZpbzy1ecTi0SUdiXHlPSW1KXmIa/TP4JV/WuXrm6GsRBETRXI6vmYCjKYYlfVziW50jYWk0BXr6QwZMFlE+rq60hw9k76LGA87hYZyHJ69qomJQSqcdIgSFuGLCR66A94QgMVDH8Q7uEQa7MGH0Fdzj3Dchxwi6QdB9QPpS0gIzVHzF19F1CD/iBcUMntjW4lmJpVgIckeGERFZQpqytpIDzX/HmtwYR6nnLabSTdQ0Nfz0aXXlWnd8DKLM/xYBJTGTlNoXoYWeRMGsFHwiZE8KVsomstHQ16uUiDY56FHjCsbmIc5+LOTFtiHe/+quuMeXmhsf9ECKAThcDNy7evCPiKgF0RYDrth4B5ohAYEP5BXfIVBl9hsCsMet1Gw8AM8J/G74O/nqH97f3WWM6f+t4VcCriYCNeChPGxZj5LJTeZYnDpPFvIsRSC4Zngq0hJzAXN2rjqkQKcBQp6BLzAw2yZuuYkTDdPQOY3pA3SCn48qca2HU3Lb7pccaFu0WhtNSlZIrEK22TS+JGbMZdssWBWi05Mp+ILe161WRwEmBBP4rjqFJZ3/rCaLw6pYeRNaSQvQZKMi591xorq2Hsj08FLcqrA13US8PBAJEFFTmZZektV5OJrArLvOJ7sFEb1hKLa6xWwJx2q/0iLbrHI0Pp1IQSGAdSedDaA52G4bH3ogfuj4+eQp4dYwM7ZeIyOkAdvI6IT68uPqhVfKxm8MlIsC+DhH1WyyPSA0BdfMw28UFGw6tPXgxjqxgbkQPnilwb+NitLj69Nr+7tuPT3sKzYcu1C9tj0oPqLj6wVXzshvGBe60+/7/Fx2zoOHfYob130Yf2aihr78c/tws7Ihx2y0d989p25IHfsXpdqwtNu3jyN9ZO/sl0Sif/cr+oew2BjXoAGSYy7Z5T6Ncym80ogMPfTVRnTX9jgo4o4fkMbDEnW0rVbg2pHWnWigxppzpdWAHjxgyiDeB1t6APAEY5iwhTWz6JCE6XRDw8mV6t2cCVfs0kuwCBoH2OAiFr9xeGeq8/3egB/VMEPEybG5/1DOiWPGOXHeM4zTqmitxKx6h3JaHANFQvGGKADvLVFpnKHmzPP/aJAvuVBMTneFJejIdMXFC4m706UDcc7d0TifbCIuFz9WrT8LDEG0fkgqSqt/40LFXV27fEo9EUh/tL9YMMY5Wi8ZBh7uVkSvo9X5kcdIYypTmpo4dUrNPFhJAF17WxUPvaGCfS5oGrVvI0e0EKodL28wwUgt2Sq06Z7Eqv4+zAKuu+K61QyClkia//cK6r9lu+Vl8SV6W6jhHddxe4gykd/s8guNOfvp/8iHABAjnNrr6ymP2UPsm/Zf+wgO7/BQ==</diagram></mxfile>

hosts/database/setup/setup.md

@@ -1,3 +1,4 @@
+## Local machine
 ```
 sudo -u postgres createuser --interactive
 createdb evs

services/requirements.txt

@@ -0,0 +1,2 @@
+requests
+