darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-24 17:31:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #76 from alphagov/update-readme

Browse Source 
Update README with set up instructions.
This commit is contained in:
Chris Hill-Scott
2016-02-17 09:58:21 +00:00
parent c1e3317967 8b4641021a
commit bb88fd79dc
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -8,21 +8,29 @@ Application for the notification api.
Read and write notifications/status queue.
Get and update notification status.
mkvirtualenv -p /usr/local/bin/python3 notifications-api
## Setting Up
```
mkvirtualenv -p /usr/local/bin/python3 notifications-api
```
Creating the environment.sh file. Replace [unique-to-environment] with your something unique to the environment. The local development environments are using the AWS on preview.
```
echo "
export ADMIN_CLIENT_USER_NAME = 'dev-notify-admin'
export ADMIN_CLIENT_SECRET = 'dev-notify-secret-key'
export AWS_REGION='eu-west-1'
export DANGEROUS_SALT = 'dangerous-salt'
export DELIVERY_CLIENT_USER_NAME='dev-notify-delivery'
export DELIVERY_CLIENT_SECRET='dev-notify-secret-key'
export NOTIFY_JOB_QUEUE='notify-jobs-queue-[-unique-to-environment]'
export NOTIFICATION_QUEUE_PREFIX='notification_development[-unique-to-environment]'
export NOTIFY_JOB_QUEUE='[unique-to-environment]-notify-jobs-queue'
export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]-notification_development'
export SECRET_KEY = 'secret-key'
export SQLALCHEMY_DATABASE_URI = 'postgresql://localhost/notification_api'
export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.works'
```
export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.works'
"> environment.sh
```
NOTE: the DELIVERY_CLIENT_USER_NAME, DELIVERY_CLIENT_SECRET, NOTIFY_JOB_QUEUE and NOTIFICATION_QUEUE_PREFIX must be the same as the ones in the [notifications-delivery](https://github.com/alphagov/notifications-delivery) app.
The SECRET_KEY and DANGEROUS_SALT are the same in [notifications-delivery](https://github.com/alphagov/notifications-delivery) and [notifications-admin](https://github.com/alphagov/notifications-admin) app