From 6279b327d60901a15f93c3ce5a2f7c29a6c719ea Mon Sep 17 00:00:00 2001 From: Leo Hemsted Date: Wed, 17 Aug 2016 15:59:16 +0100 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 375e7208e..8dec06960 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ GOV.UK Notify admin application. ## First-time setup Languages needed -- Python 3 +- Python 3.4 - [Node](http://nodejs.org/) 5.0.0 or greater ```shell brew install node @@ -34,18 +34,15 @@ version of Node. npm rebuild node-sass ``` -The app runs within a virtual environment. To [install virtualenv](https://virtualenv.readthedocs.org/en/latest/installation.html), run -```shell - [sudo] pip install virtualenv -``` - -Make a virtual environment for this app: +The app runs within a virtual environment. We use mkvirtualenv for easier working with venvs ```shell + pip install virtualenvwrapper mkvirtualenv -p /usr/local/bin/python3 notifications-admin ``` Install dependencies and build the frontend assets: ```shell + workon notifications-admin ./scripts/bootstrap.sh ``` @@ -74,6 +71,10 @@ export DESKPRO_ASSIGNED_AGENT_TEAM_ID="" "> 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