mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-09-10 01:55:41 -04:00
Update README.md
This commit is contained in:
15
README.md
15
README.md
@@ -19,7 +19,7 @@ GOV.UK Notify admin application.
|
|||||||
## First-time setup
|
## First-time setup
|
||||||
|
|
||||||
Languages needed
|
Languages needed
|
||||||
- Python 3
|
- Python 3.4
|
||||||
- [Node](http://nodejs.org/) 5.0.0 or greater
|
- [Node](http://nodejs.org/) 5.0.0 or greater
|
||||||
```shell
|
```shell
|
||||||
brew install node
|
brew install node
|
||||||
@@ -34,18 +34,15 @@ version of Node.
|
|||||||
npm rebuild node-sass
|
npm rebuild node-sass
|
||||||
```
|
```
|
||||||
|
|
||||||
The app runs within a virtual environment. To [install virtualenv](https://virtualenv.readthedocs.org/en/latest/installation.html), run
|
The app runs within a virtual environment. We use mkvirtualenv for easier working with venvs
|
||||||
```shell
|
|
||||||
[sudo] pip install virtualenv
|
|
||||||
```
|
|
||||||
|
|
||||||
Make a virtual environment for this app:
|
|
||||||
```shell
|
```shell
|
||||||
|
pip install virtualenvwrapper
|
||||||
mkvirtualenv -p /usr/local/bin/python3 notifications-admin
|
mkvirtualenv -p /usr/local/bin/python3 notifications-admin
|
||||||
```
|
```
|
||||||
|
|
||||||
Install dependencies and build the frontend assets:
|
Install dependencies and build the frontend assets:
|
||||||
```shell
|
```shell
|
||||||
|
workon notifications-admin
|
||||||
./scripts/bootstrap.sh
|
./scripts/bootstrap.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -74,6 +71,10 @@ export DESKPRO_ASSIGNED_AGENT_TEAM_ID=""
|
|||||||
"> environment.sh
|
"> environment.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## AWS credentials
|
||||||
|
|
||||||
|
Your aws credentials should be stored in a folder located at `~/.aws`. Follow [Amazon's instructions](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) for storing them correctly
|
||||||
|
|
||||||
|
|
||||||
## Running the application
|
## Running the application
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user