=============================== Civil Service Digital Prototype

Requirements

• python 3
• mongodb
• sass (for flask assets)
• virtualenv and virtualenvwrapper (not a hard requirement but steps below assume you are using them)

Quickstart

Checkout this repo.

Install the requirements above if you don't already have them installed.

Then run the following commands to bootstrap your environment.

mkvirtualenv --python=/path/to/python3 [appname]

Change to the directory you checked out and install python requirements.

pip install -r requirements.txt

The base environment variables for running application locally are in environment.sh. See below for any private environment variables.

Once that this all done you can:

Start mongo:

mongod

Fake IdPs

1. To fire up the fake DWP and Cabinet Office IdPs, run the following commands in a new terminal:

   python manage.py fake-idp -p 8080 -n "Cabinet Office"
   

   You will be prompted for an admin username, email and password.

2. Browse to http://localhost:8080/admin/oidc_provider/client/add/ and login with the username and password you just supplied.

   Enter a Name and choose code (Authorization Code Flow) for Response type. Enter http://localhost:8000/login/callback in the Redirect URI field.

   Click Save and continue editing and make a note of the Client id and Client secret field values.

3. Return to the prototype terminal and enter the following:

   export CO_IDP_CLIENT_ID=<Client id value>
          CO_IDP_CLIENT_SECRET=<Client secret value>
   

Repeat this process with the following changes for the DWP IDP:

1. In a new terminal, run the IdP app: python manage.py fake-idp -p 8088 -n "DWP"

2. Add a client: http://localhost:8088/admin/oidc_provider/client/add/

3. Set the environment variables in the prototype terminal:

   export DWP_IDP_CLIENT_ID=<Client id value>
          DWP_IDP_CLIENT_SECRET=<Client secret value>
   

Then run app

./run.sh

Tests

Make sure mongo is running

make test

Deployment

In your production environment, make sure the SETTINGS environment variable is set to config.Config.

Private environment variables

Anything that is not sensitive and can go in version control can be put into environment.sh. For anything private, add a file called environment-private.sh (which is git ignored) and put the variables in that file.

Adding data - a.k.a. management commands

To run any of these locally first source environment.sh

source environment.sh

Note: To erase all data in the database, use the following command (carefully!):

python manage.py erase-db

Load competency framework data

python manage.py load-competency-data

Create all xgs users

python manage.py create-xgs-users

Create an ordinary (non admin user)

python manage.py create-user

Answer prompts - (note password not used yet)

Add an objective for a user

python manage.py add-user-objective

Answer prompt for email of user to add objective for.

To reset

With mongo running log into mongo

Switch dbs

use xgs

Remove everything

db.dropDatabase()

Then add everything with management commands as above