Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

add serverside testing #139

Merged
merged 15 commits into from
Dec 11, 2019
Prev Previous commit
Next Next commit
remove sample env, update docs
  • Loading branch information
timmyichen committed Dec 6, 2019

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 732b8c6ab25309b887de4bfe5e4a9538455524c3
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -79,8 +79,7 @@ Install dependencies:
npm install
```

Setup Environment Variables:
Copy and paste env.sample into your .env file
If needed, set up environment variables under 'app -> environment' in the `docker-compose.yml` file.

Ensure that Docker Desktop is up and running, then run the following command:
```
4 changes: 4 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -19,6 +19,10 @@ services:
- DB_PASSWORD=password
- DB_NAME=chapter
- DB_URL=db
- CHAPTER_EMAIL=ourEmail@placeholder.place
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Env variables will grow in the future, shouldn't we maintain separate .env

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for the most part, there's no functional difference between having a long list of env variables in the docker-compose file and a long list of env variables in .env. With a separate .env file, you are requiring people to copy/rename a file before running it whereas this will be set up when you run docker-compose up.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the sake of simplicity I think that for now we should stick with env vars in docker-compose, but maybe later when we have a lot of them we could extract them.

- EMAIL_USERNAME=emailUsernamePlaceholder
- EMAIL_PASSWORD=emailPasswordPlaceholder
- EMAIL_SERVICE=emailServicePlaceholder
volumes:
- .:/usr/chapter
ports:
4 changes: 0 additions & 4 deletions env.sample

This file was deleted.