Skip to content

Latest commit

 

History

History
125 lines (78 loc) · 3.84 KB

README.md

File metadata and controls

125 lines (78 loc) · 3.84 KB
Raw

export-wins-ui

The UI component for the export-wins application.

Requires the Export wins data application to be running first.

Setup

After activating a python virtual environment using the instructions below, you can follow the commands in the Makefile to most easily run the app.

Python

  • Install Python3 if you don't have it already
  • Create a virtual env for the project:
python3 -m venv /path/to/virtal-envs/export-wins-ui
  • Then activate the virtual env:
source /path/to/virtal-envs/export-wins-ui/bin/activate
  • Install the dependencies:

To run the app you need to install the python requirements:

pip install -r requirements.txt

Environment

Copy the .env template file into a .env file to set the variables that are required to start

cp .env.template .env

To make life easier, setup a shell extension to read a .env or .envrc file, like direnv. Without this, you will need to run source .env following any changes to your environment variables.

You need to have two ENV vars set: UI_SECRET and DATA_SERVER.

  • UI_SECRET is the secret created by the data server
  • DATA_SERVER is the URL to the data server i.e. http://127.0.0.1:8001

Debug

If you want useful errors when there is an error also create:

DEBUG='true';

Build

There is a grunt build process which:

  • builds the bootstrap CSS from SASS
  • concat/uglify the bootstrap JS
  • builds the app CSS from SASS
  • concat/uglify the app JS

First we need the dependencies:

npm install

To run the build:

npm run build

To help when developing the assets, there is also a watch task to run the build automatically when the files change:

npm run watch

Bootstrap

As we aren't using a lot of the features provided by Bootstrap, there is a copy of the bootstrap.scss file called main.scss and this has several of the components removed - so if you want to use something and it doesn't seem to work, this will probably be why.

This also includes the JavaScript: all the available files are included in the Gruntfile.js but most have been commented out.

Run

Before starting the app you need to have the data server running, and then run:

python manage.py runserver 127.0.0.1:8000

The app should now be running on port 8000. Often you will have trouble accessing via 0.0.0.0:8000, so will need to access via localhost:8000 in your browser.

NOTE: The export wins data service will normally run on port 8001.

IE 7

We have several users that seem to be stuck with IE 7, so we therefore need to support it.

To try and enable support of IE 7 to Bootstrap, an ie7.css has been included, with a box-sizing polyfill

Docker

The docker image should be built automatically in docker hub. To start the image you need to pass the required env variables:

OSX

docker run -e "COOKIE_SECRET=${COOKIE_SECRET}" -e "UI_SECRET=${UI_SECRET}" -e "DATA_SERVER=http://10.200.10.1:8000" -e "SECRET_KEY=${SECRET_KEY}" -e "DEBUG=True" -d -p 8002:8001 ukti/export-wins-ui:latest

Linux

Linux can connect to the host and so as long as you have a data server running on port 8000, this will work:

docker run -e "COOKIE_SECRET=${COOKIE_SECRET}" -e "UI_SECRET=${UI_SECRET}" -e "SECRET_KEY=${SECRET_KEY}" -e "DEBUG=True" --net=host -d -p 8002:8001 ukti/export-wins-ui:latest

Deploying

Note that if there have been changes to the models in export-wins-data, including metadata changes, export-wins-ui will need to also be redeployed as it gets data on startup from export-wins-data.