GP Finder
A GP surgery finder application to allow the user to easily navigate to a GP surgery's online booking system.
Test environments
As the application is being developed, every Pull Request has its own test environment automatically built and deployed to.
Every environment apart from the one we want the public to access requires basic authentication to access. The username and password are not secret, in fact they are included within environment variable table below. The intention with the authentication challenge is to prevent people whom may stumble across the site and not realise it is for testing, it also prevents access by search engines and other bots.
Environment variables
Environment variables are expected to be managed by the environment in which the application is being run. This is best practice as described by twelve-factor.
| Variable | Description | Default |
|---|---|---|
NODE_ENV |
Node environment | development |
LOG_LEVEL |
Numeric log level | Depends on NODE_ENV |
PORT |
Port web server is accessible on | 3000 |
ES_HOST |
Elasticsearch host name | es |
ES_PORT |
Elasticsearch port | 9200 |
GOOGLE_ANALYTICS_TRACKING_ID |
Google Analytics property id | |
WEBTRENDS_ANALYTICS_TRACKING_ID |
Webtrends tracking id | |
HOTJAR_ANALYTICS_TRACKING_ID |
Hotjar tracking id | |
BASIC_AUTH |
An MD5 encrypted htpasswd | test:test |
Application development
The application has some scripts to make things easier for development. For more information about scripts, please read the info here.
Please run the ./scripts/bootstrap script first and
follow the instructions.
For application specific development, start by cloning the repo and all
submodules i.e. git clone https://github.com/nhsuk/gp-finder.git && cd gp-finder/ && git submodule update --init --recursive
You can run the application using ./scripts/start.
The application will be available locally on http://localhost:3000 and any changes you make
will be reflected in the app.
You can run the tests using ./scripts/test.
Continuous development
First time run - please run yarn install locally as we are using
Husky to manage our git hooks that will
ensure a baseline code quality.
You can run the tests continuously using ./scripts/test, and
once you are happy with the changes you have made and want to commit and push
your changes, some git hooks will run as spot checks for linting, unit tests
and security vulnerabilities.
Architecture Decision Records
This repo uses Architecture Decision Records to record architectural decisions for this project. They are stored in doc/adr.