@@ -16,41 +16,61 @@ A Flask application template with the boilerplate code already done for you.
1616
1717## Setting up
1818
19- 1 . Clone the repo
19+ ##### Clone the repo
2020
2121 ```
2222 $ git clone https://github.com/hack4impact/flask-base.git
2323 $ cd flask-base
2424 ```
2525
26- 2. Initialize a virtualenv
26+ ##### Initialize a virtualenv
2727
2828 ```
2929 $ pip install virtualenv
3030 $ virtualenv env
3131 $ source env/bin/activate
3232 ```
3333
34- 3. Install the dependencies
34+ ##### Install the dependencies
3535
3636 ```
3737 $ pip install -r requirements/common.txt
3838 $ pip install -r requirements/dev.txt
3939 ```
4040
41- 4. Create the database
41+ ##### Other dependencies for running locally
42+
43+ You need to install [ Foreman] ( https://ddollar.github.io/foreman/ ) and [ Redis] ( http://redis.io/ ) . Chances are, these commands will work:
44+
45+ ```
46+ $ gem install foreman
47+ ```
48+
49+ Mac (using [ homebrew] ( http://brew.sh/ ) ):
50+
51+ ```
52+ $ brew install redis
53+ ```
54+
55+ Linux:
56+
57+ ```
58+ $ sudo apt-get install redis-server
59+ ```
60+
61+ ##### Create the database
4262
4363 ```
4464 $ python manage.py recreate_db
4565 ```
4666
47- 5. Other setup (e.g. creating roles in database)
67+ ##### Other setup (e.g. creating roles in database)
4868
4969 ```
5070 $ python manage.py setup_dev
5171 ```
5272
53- 6. [Optional] Add fake data to the database
73+ ##### [ Optional] Add fake data to the database
5474
5575 ```
5676 $ python manage.py add_fake_data
@@ -60,9 +80,7 @@ A Flask application template with the boilerplate code already done for you.
6080
6181```
6282$ source env/bin/activate
63- $ python manage.py runserver
64- * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
65- * Restarting with stat
83+ $ foreman start -f Local
6684```
6785
6886## Project Structure
0 commit comments