search

Crown-Commercial-Service / digitalmarketplace-admin-frontend

Frontend administration application for the digital marketplace
MIT License
5 stars 14 forks source link
digitalmarketplace portfolio

readme

Digital Marketplace Admin Frontend

Python 3.9

Frontend application for the Digital Marketplace.

This app contains journeys for different admin user roles:

Quickstart

It's recommended to use the DM Runner tool, which will install and run the app as part of the full suite of apps.

If you want to run the app as a stand-alone process, clone the repo then run:

make run-all

This command will install dependencies and start the app.

By default, the app will be served at http://127.0.0.1:5004/admin.

API dependencies

(If you are using DM Runner you can skip this section.)

The Brief Responses Frontend app requires access to the API app. The location and access token for this service are set with environment variables in config.py.

For development, you can either point the environment variables to use the preview environment's API box, or use a local API instance if you have one running:

export DM_DATA_API_URL=http://localhost:5000
export DM_DATA_API_AUTH_TOKEN=<auth_token_accepted_by_api>

Where DM_DATA_API_AUTH_TOKEN is a token accepted by the Data API instance pointed to by DM_API_URL.

Note: The login is handled in the User Frontend app, so this needs to be running as well, to login as an admin.

Configuring AWS access

The Admin Frontend app uses boto as a Python interface for our AWS S3 buckets.

You will need to have AWS access keys set up on your local machine (which boto will automatically detect), otherwise some pages in the app will give an error message.

Full instructions on how to do this can be found in the Developer Manual.

If you're experiencing problems connecting, make sure to unset any env variables used by boto (e.g. AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SECURITY_TOKEN and AWS_PROFILE) as they may be overriding the values in your credentials file.

Testing

Run the full test suite:

make test

To only run the Python or Javascript tests:

make test-python
make test-javascript

To run the flake8 linter:

make test-flake8

Updating Python dependencies

requirements.txt file is generated from the requirements.in in order to pin versions of all nested dependencies. If requirements.in 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 committed alongside requirements.in changes.

Frontend assets

Front-end code (both development and production) is compiled using Node and Gulp.

Requirements

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

Frontend tasks

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

Updating NPM dependencies

Update the relevant version numbers in package.json, then run

npm install

Commit the changes to package.json and package-lock.json.

You can also run npm audit fix to make minor updates to package-lock.json.

Contributing

This repository is maintained by the Digital Marketplace team at the Crown Commercial Service.

If you have a suggestion for improvement, please raise an issue on this repo.

Reporting Vulnerabilities

If you have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner.

Please follow the CCS vulnerability reporting steps, giving details of any issue you find. Appropriate credit will be given to those reporting confirmed issues.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.