From bb86f5f359e2d1c7cbaf942099cc6b53d2c5fa4d Mon Sep 17 00:00:00 2001 From: "Sachin S. Kamath" <sskamath96@gmail.com> Date: Sat, 30 Sep 2017 14:45:02 +0530 Subject: [PATCH] Add quickstart to README Signed-off-by: Sachin S. Kamath <sskamath96@gmail.com> --- README.markdown | 19 ------------------- README.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 19 deletions(-) delete mode 100644 README.markdown create mode 100644 README.md diff --git a/README.markdown b/README.markdown deleted file mode 100644 index f5d40e0..0000000 --- a/README.markdown +++ /dev/null @@ -1,19 +0,0 @@ -A simple boilerplate application following the MVC pattern using Flask micro python framework. -It basically here to be my base skeleton for new python web applications - -Demo : http://flask-mvc-salimane.herokuapp.com/ - -Dependencies : - - git clone git://github.com/salimane/flask-mvc.git - cd flask-mvc - if you have old version of project: pip uninstall -r requirements.txt - pip install -r requirements.txt - -To run: - - python runserver.py - - -[](https://bitdeli.com/free "Bitdeli Badge") - diff --git a/README.md b/README.md new file mode 100644 index 0000000..ae7028a --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Hodor WebApp + +The web application for the Hodor Project + +## Quickstart +* Clone the repo using `git clone https://git.amrita.edu/hodorsec/hodor-webapp` +* Create a virtualenv and activate it. +* After activating it, `pip install -r requirements.txt` to install dependencies. +* `./runserver.py` to run the app. +* Navigate to `http://127.0.0.1:8080` to watch it in action! + + -- GitLab