diff --git a/README.markdown b/README.markdown deleted file mode 100644 index f5d40e0bee7f247b8a93e6beaa27fe19fbf5e821..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..ae7028ad1e2a82ef76a3fa8626c6e06c2a86e86b --- /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! + +