From 4c38341c4d99b79aa6e756c0f67957ecc148ffd8 Mon Sep 17 00:00:00 2001
From: Raghotham S <raghotham.s@gmail.com>
Date: Thu, 4 Aug 2016 09:33:49 +0530
Subject: [PATCH] Adding instructions to run the project

---
 app.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 app.md

diff --git a/app.md b/app.md
new file mode 100644
index 0000000..7956b6c
--- /dev/null
+++ b/app.md
@@ -0,0 +1,47 @@
+# How do I get this running?
+
+## Folder structure
+
+![](https://github.com/unnati-xyz/fifthel-2016-workshop/blob/master/proj-structure.png)
+
+### data
+This folder contains all the csv files required to run the project
+
+### logs
+This folder contains the daily logs created by the application
+
+### luigi_tasks
+This folder contains the luigi tasks to run. These files internally uses the modules in `poget`
+
+### poget
+This is the base application folder which has multiple modules
+
+* `analytics/data_load`
+
+  This module has all the files to load data in csv to postgres db
+  
+* `analytics/ml`
+  
+  This module has all the files related to spark machine learning
+  
+* `api`
+  
+  This contains the flask application & the endpoints
+  
+* `utils`
+
+  This contains all the utilities used in the application
+  
+## Order of execution to see the demo
+
+* Load data from csv to postgres DB
+
+```luigi --module luigi_tasks.load_trip_task LoadTripTask```
+
+* Run the Spark ML model
+
+```luigi --module luigi_tasks.terminal_traffic_task TerminalTrafficTrainTask```
+
+* Run the flask server
+
+```python3 runserver.py```