Skip to content

Commit c4df272

Browse files
francislicatarak
authored andcommitted
Fixes #484 by adding MAILGUN_KEY variable to README instructions on setting up .env file, and by adding a default value to the docker-compose environment. (#487)
1 parent 03eae2f commit c4df272

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ This project is currently in development! It will be announced when there is a (
2424
S3_BUCKET=<your-s3-bucket>
2525
GITHUB_ID=<your-github-client-id>
2626
GITHUB_SECRET=<your-github-client-secret>
27+
MAILGUN_KEY=<your-mailgun-api-key>
2728
```
29+
2830
If you don't care about being able to upload media files to S3 or Login with Github, you can drop in the file exactly how it is. Or, if you don't want to do that, just ask me to send you mine. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing, or if you don't want to do that, I can add you to one of my S3 buckets.
2931

3032
7. `$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
@@ -42,7 +44,7 @@ The automatic redirection to HTTPS is turned off by default in development. If y
4244

4345
Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc.
4446

45-
Note that this takes up a significant amount of space on your machine. Make sure you have at least 5GB free.
47+
Note that this takes up a significant amount of space on your machine. Make sure you have at least 5GB free.
4648

4749
1. Install Docker for your operating system
4850
* Mac: https://www.docker.com/docker-mac

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ services:
1616
- S3_BUCKET=override_in_dotenv
1717
- GITHUB_ID=override_in_dotenv
1818
- GITHUB_SECRET=override_in_dotenv
19+
- MAILGUN_KEY=override_in_dotenv
1920
volumes:
2021
- .:/opt/node/app
2122
- /opt/node/app/node_modules

0 commit comments

Comments
 (0)