Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add .env File #105

Merged
merged 10 commits into from Nov 8, 2019
Merged

Add .env File #105

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3f3f9dd
changes for env
s-arika Nov 8, 2019
db3ea68
changes for config
s-arika Nov 8, 2019
49f2371
Update .env.example
Nov 8, 2019
619581b
Update CONTRIBUTING.md
Nov 8, 2019
5495bf9
changed .env name, comments in .env and delete config folder
s-arika Nov 8, 2019
eb36bcd
pull from issue60
s-arika Nov 8, 2019
8e37d2d
Update env.example
Nov 8, 2019
423dbb1
changes for contributing, env and config
s-arika Nov 8, 2019
752b3b4
changes for env
s-arika Nov 8, 2019
15da30a
Update config.js
Nov 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .env.example
View file
Open in desktop
@@ -0,0 +1,4 @@
NODE_ENV=development
Copy link
Contributor

Choose a reason for hiding this comment

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

Above each line, please add a comment

# NODE_ENV should be one of "development" or "production"
NODE_ENV=development

# PORT is the port used by the web server
PORT=8080

...

This example file can serve as both a template, and documentation.

Copy link
Author

Choose a reason for hiding this comment

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

  • renamed .env.example to env.example
  • added instructions in contributing.md
  • added comments in env.example

PORT=8080
NODEMAILER_USERNAME=
NODEMAILER_PASSWORD=
10 changes: 10 additions & 0 deletions config/config.js
View file
Open in desktop
@@ -0,0 +1,10 @@
const dotenv = require('dotenv');

dotenv.config();

module.exports = {
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder about this vs. just letting people use process.env everywhere. If we go with this approach, then every file has to require this file. If we leave it all on process.env.* we don't.

I'd suggest we remove this and export nothing from config.js, and just make sure we require('./config') early in the code.

Copy link
Author

Choose a reason for hiding this comment

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

ok, do you want me to add

const dotenv = require('dotenv');
dotenv.config();

at the very beginning of index.js for now ?

port: process.env.PORT,
env: process.env.NODE_ENV,
user: process.env.NODEMAILER_USERNAME,
pass: process.env.NODEMAILER_PASSWORD,
};
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Expand Up @@ -18,7 +18,8 @@
"homepage": "https://github.com/Seneca-CDOT/telescope#readme",
"dependencies": {
"bent": "^7.0.2",
"bull": "^3.11.0"
"bull": "^3.11.0",
"dotenv": "^8.2.0"
},
"devDependencies": {
"eslint": "^6.6.0",
Expand Down