Skip to content

Commit

Permalink
keep documentation up to date
Browse files Browse the repository at this point in the history
  • Loading branch information
pkage committed Oct 20, 2020
1 parent 6272fd7 commit 3d1aed2
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,39 @@ https://www.eusa.ed.ac.uk/organisation/admin/8868/
HERE
```

To use the dashboard, you'll need to add some Google OAuth keys to auth with
our GAdmin workspace. Follow the instructions in [the compsoc-sso-template
repo](https://github.com/compsoc-edinburgh/compsoc-sso-framework#how) (may be
private), and then add them to the `secret.json` file:

```
{
// ...
"google": {
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"callback": "https://YOUR_DEPLOYMENT_URL/auth/google/callback"
}
}
```

Additionally, you'll need to add the sendy API key, deployment, and target
list. Instructions on how to find this information can be found at the [Sendy
API documentation](https://sendy.co/api). Once you get this information, you
can set it in `secret.json`:

```
{
// ...
"sendy": {
"sendy_url": "https://YOUR_SENDY_URL/sendy",
"api_key": "YOUR_SENDY_API_KEY",
"target_list": "YOUR_SENDY_TARGET_LIST"
}
}
```


## run (dev)

```bash
Expand Down

0 comments on commit 3d1aed2

Please sign in to comment.