From e93bb6e7f8ae1ffd43bc180fa728d30a9cc14a24 Mon Sep 17 00:00:00 2001 From: Bryan Date: Sun, 14 Jun 2015 22:07:17 -0400 Subject: [PATCH] reinforcing the .env instruction --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c82322c..99b1177 100644 --- a/README.md +++ b/README.md @@ -79,8 +79,7 @@ accounts to access the service APIs. Without these third parties available, this software may require considerable overhaul. These services have API keys, credentials, and other information that you must provide to KarmaWorld as environment variables. The best way to persist these environment variables is -by using a `.env` file. Copy `.env.example` to `.env` and populate the fields as -required. +by using a `.env` file. Copy `.env.example` to `.env` and populate the fields as required. A number of services are required even if running the KarmaWorld web service locally, some of the services are recommended, and some are completely optional @@ -89,6 +88,8 @@ even if running the web service on Heroku. Many of these services have free tiers and can be used without charge for development testing purposes. +* Reminder + * Copy `.env.example` to `.env` and populate the environment variables there. * Required Services * [Google Drive](#google-drive) * [Filepicker](#filepicker) @@ -398,6 +399,14 @@ Then patch the javascript on your system by running this code in the shell. * on Debian systems, some packages are required for pip to succeed: * `apt-get install python-dev libpython-dev python-psycopg2 libmemcached-dev libffi-dev libssl-dev postgresql-server-dev-X.Y` 1. `pip install -r requirements-dev.txt` + +## Configuration + +Make sure [External Service Dependencies](#external_service_dependencies) are +satisfied. This includes running a local database and RabbitMQ instance as +desired. + + 1. configure `.env` as per [instructions](#external_service_dependencies) 1. `foreman run python manage.py syncdb --migrate --noinput` 1. `foreman run python manage.py createsuperuser` 1. `foreman run python manage.py fetch_usde_csv ./schools.csv` -- 2.25.1