Frontend buyer application for the digital marketplace.
- Python app, based on the Flask framework
Install Virtualenv
sudo easy_install virtualenv
Install dependencies, run migrations and run the app
make run-all
Install Virtualenv
sudo easy_install virtualenv
The buyer frontend app requires access to both the API (for service pages) and to the search API (for search results). The location and access tokens for these services is set with environment variables.
For development you can either point the environment variables to use the
preview environment's API and Search API boxes, or use local API instances if
you have them running:
export DM_DATA_API_URL=http://localhost:5000
export DM_DATA_API_AUTH_TOKEN=<auth_token_accepted_by_api>
export DM_SEARCH_API_URL=http://localhost:5001
export DM_SEARCH_API_AUTH_TOKEN=<auth_token_accepted_by_search_api>
Where DM_DATA_API_AUTH_TOKEN is a token accepted by the Data API
instance pointed to by DM_API_URL, and DM_SEARCH_API_AUTH_TOKEN
is a token accepted by the Search API instance pointed to by DM_SEARCH_API_URL.
virtualenv ./venv
source ./venv/bin/activate
Install new Python dependencies with pip
pip install -r requirements-dev.txt
Install frontend dependencies with yarn and gulp
yarn
To run the whole testsuite:
make test
To only run the JavaScript tests:
make test-javascript
To run the Buyer Frontend App for local development you can use the convenient run script, which sets the required environment variables to defaults if they have not already been set:
make run-app
More generally, the command to start the server is:
python application.py runserver
The buyer app runs on port 5002 by default. Use the app at http://127.0.0.1:5002/
requirements.txt file is generated from the requirements-app.txt in order to pin
versions of all nested dependecies. If requirements-app.txt has been changed (or
we want to update the unpinned nested dependencies) requirements.txt should be
regenerated with
make freeze-requirements
requirements.txt should be commited alongside requirements-app.txt changes.
To use feature flags, check out the documentation in (the README of) digitalmarketplace-utils.
Front-end code (both development and production) is compiled using Node and Gulp.
You need Node (try to install the version we use in production - see the base docker image).
To check the version you're running, type:
node --version
You'll also need yarn
To install the required Node modules, type:
yarn
YARN is used for all frontend build tasks. The commands available are:
yarn run frontend-build:development(compile the frontend files for development)yarn run frontend-build:production(compile the frontend files for production)yarn run frontend-build:watch(watch all frontend+framework files & rebuild when anything changes)