@@ -13,6 +13,7 @@ To run a copy of this project locally you will require:
1313+ Docker(Optional)
1414+ Redis server(Optional)
1515
16+
1617### Installation
1718
1819You can run a local version of flashlearn by cloning this repo
@@ -26,16 +27,17 @@ and following these instructions
2627 source venv/bin/activate
2728 pip install -r requirements.txt
2829
30+ If pip installation fails but you dont need postgresql database feel free to remove ** psycopg2** from the list and try the installation again.
2931The file .flaskenv is populated with default development configs that you
3032can override to suit your needs.
3133To run the server directly type
3234
3335 flask run --host=0.0.0.0
3436
3537
38+
3639#### Setting up Postgresql
37- First ensure the latest version of postgresql is installed, If pip installation
38- fails but you dont need postgres feel free to remove ** psycopg2** from the list and try the installation again.
40+ First ensure the latest version of postgresql is installed!
3941To setup psql proceed as follows:
4042
4143+ Create a new postgres user, set the user password and make sure that you can access psql shell
@@ -45,18 +47,21 @@ To setup psql proceed as follows:
4547Ignore this step to use sqlite3
4648
4749
50+
51+
4852#### Setting up Redis cache
4953Ensure you have redis server installed in your system.
5054Enable Redis cache from BaseConfig class file in /instance/config.py by
5155changing the value of ** USE_REDIS_CACHE** from False to True
5256
5357
58+
5459#### Running on Docker
5560First ensure docker and docker-compose are installed in your machine, then run:
5661
5762 + Copy paste the contents of .env.dev into a new file named.env.prod
5863
59- Run :
64+ To run the app with all services defined in the docker-compose file run :
6065
61- docker-compose up --build to deploy the app with docker-compose file
66+ docker-compose up --build
6267
0 commit comments