README.md

Digital Marketplace admin frontend

Frontend administration application for the digital marketplace.

• Python app, based on the Flask framework

Quickstart

Install Virtualenv

sudo easy_install virtualenv

Install dependencies, build assets and run the app

make run_all

Full setup

Install Virtualenv

sudo easy_install virtualenv

Create a virtual environment

virtualenv ./venv

Activate the virtual environment

source ./venv/bin/activate

Upgrade dependencies

Install new Python dependencies with pip

make requirements_for_test

Install frontend dependencies with npm and gulp

npm install

Compile the front-end code

You need Node (minimum version of 0.10.0, maximum version 0.12.7) which will also get you NPM, Node's package management tool.

To check the version you're running, type:

node --version

For development usage:

npm run frontend-build:development

For production:

npm run frontend-build:production

Note: running npm run frontend-build:watch will also build the front-end code.

Run the tests

make test

Run the development server

To run the Admin Frontend App for local development use the run_all target. This will install requirements, build assets and run the app.

make run_all

To just run the application use the run_app target.

The admin frontend runs on port 5004. Use the app at http://127.0.0.1:5004/admin/

Using FeatureFlags

To use feature flags, check out the documentation in (the README of) digitalmarketplace-utils.

Frontend tasks

NPM is used for all frontend build tasks. The commands available are:

• npm run frontend-build:development (compile the frontend files for development)
• npm run frontend-build:production (compile the frontend files for production)
• npm run frontend-build:watch (watch all frontend files & rebuild when anything changes)
• npm run frontend-install (install all non-NPM dependancies)

Note: npm run frontend-install is run as a post-install task after you run npm install.