Revise README to be similar to API app

This restructures the sections based on what we agreed for the API
repo.
This commit is contained in:
Ben Thorner
2021-02-22 17:12:03 +00:00
parent c1cbd9c34a
commit 864f4bef66

View File

@@ -2,8 +2,6 @@
GOV.UK Notify admin application - https://www.notifications.service.gov.uk/
## Features of this application
- Register and manage users
- Create and manage services
- Send batch emails and SMS by uploading a CSV
@@ -11,37 +9,24 @@ GOV.UK Notify admin application - https://www.notifications.service.gov.uk/
## Setting up
### Make sure you're using correct language versions
### Python version
Languages needed
- Python 3.6.x
At the moment we run Python 3.6 in production.
Need to install node? Run:
### NPM packages
```shell
brew install node
```
#### `n` For Node version management
[NPM](npmjs.org) is Node's package management tool. `n` is a tool for managing
different versions of Node. The following installs `n` and uses the long term support (LTS)
version of Node.
[NPM](npmjs.org) is Node's package management tool. `n` is a tool for managing different versions of Node. The following installs `n` and uses the long term support (LTS) version of Node.
```shell
npm install -g n
n lts
```
### Install Python dependencies
Install dependencies and build the frontend assets:
```shell
make bootstrap
```
### Create a local `environment.sh` file
### `environment.sh`
In the root directory of the application, run:
@@ -58,15 +43,26 @@ export WERKZEUG_DEBUG_PIN=off
To run parts of the app, such as uploading letters, you will need appropriate AWS credentials. See the [Wiki](https://github.com/alphagov/notifications-manuals/wiki/aws-accounts#how-to-set-up-local-development) for more details.
### Running the application
In the root directory of the application, run:
## To run the application
```shell
# install dependencies, etc.
make bootstrap
# run the web app
make run-flask
```
Then visit [localhost:6012](http://localhost:6012)
Then visit [localhost:6012](http://localhost:6012).
## To test the application
```
# install dependencies, etc.
make bootstrap
make test
```
## Updating application dependencies