From 85b23f473e0631df3b58f25972e7c410a5deafbc Mon Sep 17 00:00:00 2001 From: Bo-Chun Louis Chen <louistw@uab.edu> Date: Fri, 25 May 2018 16:38:12 -0500 Subject: [PATCH] Added Installation section --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 5993ea1..234dcf5 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,38 @@ This is a project implementing the blog post by Mbithe Nzomo. $ pip install Flask ``` +### Installation + +Install packages needed via pip +```shell +$ pip install -r requirement.txt +``` + +Setup environment variables +```shell +$ export FLASK_CONFIG=development +$ export FLASK_ENV=development +$ export FLASK_APP=run.py +``` + +Setup your own configuration +``` +$ cp instance/config.py.default instance/config.py +$ vim instance/config.py +``` + +Initialize you database +```shell +$ flask db init +$ flask db migrate +$ flask db upgrade +``` + +Finally, you can run your app +```shell +$ flask run +``` + ### Resources: - [Part one](https://scotch.io/tutorials/build-a-crud-web-app-with-python-and-flask-part-one) -- GitLab