Skip to content

Commit

Permalink
Housekeeping - Correct the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Cruikshanks committed Nov 14, 2024
1 parent 6340f3c commit 4536b14
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,17 @@ This API provides an interface for calculating charges, queuing transactions and

Make sure you already have:

- [Node.js v16.\*](https://nodejs.org/en/)
- [PostgreSQL v12](https://www.postgresql.org/)
- [Node.js v20.\*](https://nodejs.org/en/)
- [PostgreSQL v14](https://www.postgresql.org/)

## Installation
## Running locally

First clone the repository and then drop into your new local repo:

```bash
git clone https://github.com/DEFRA/water-abstraction-system.git && cd water-abstraction-system
```

Create the databases:

```bash
npm run create-db
npm run create-test-db
```

Our preference is to run the database and API within Docker, so [install Docker](https://docs.docker.com/get-docker/) if you don't already have it.
This is one of a number of apps that make up the Water Resource Licencing service. Because of the service's complex infrastructure there is a separate project available that will build a fully working WRLS environment, using [Docker](https://docs.docker.com/get-docker/). We recommend reaching out to the [Water Abstraction team](https://github.com/orgs/DEFRA/teams/water-abstraction) and requesting access to **wal-dev-environment** if you need to get this project up and running.

## Configuration

> This is automatically setup when running locally using **wal-dev-environment**
Any configuration is expected to be driven by environment variables when the service is run in production as per [12 factor app](https://12factor.net/config).

However when running locally in development mode or in test it makes use of the [Dotenv](https://github.com/motdotla/dotenv) package. This is a shim that will load values stored in a `.env` file into the environment which the service will then pick up as though they were there all along.
Expand Down

0 comments on commit 4536b14

Please sign in to comment.