From 3f3f9ddc2a20f6c56c2005347d22b50a530cafeb Mon Sep 17 00:00:00 2001 From: s-arika Date: Fri, 8 Nov 2019 08:49:18 -0500 Subject: [PATCH 1/8] changes for env --- .env.example | 4 ++++ config/config.js | 8 ++++++++ package.json | 3 ++- 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .env.example create mode 100644 config/config.js diff --git a/.env.example b/.env.example new file mode 100644 index 0000000000..aadcdd5415 --- /dev/null +++ b/.env.example @@ -0,0 +1,4 @@ +NODE_ENV=development +PORT=8080 +NODEMAILER_USERNAME= +NODEMAILER_PASSWORD= \ No newline at end of file diff --git a/config/config.js b/config/config.js new file mode 100644 index 0000000000..5fcb47e2ff --- /dev/null +++ b/config/config.js @@ -0,0 +1,8 @@ +const dotenv = require('dotenv'); + +dotenv.config(); + +module.exports = { + port: process.env.PORT, + env: process.env.NODE_ENV, +}; diff --git a/package.json b/package.json index f1df3627db..cf49f8496b 100644 --- a/package.json +++ b/package.json @@ -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", From db3ea685c87cca79920105713228c5c7ed3b9e45 Mon Sep 17 00:00:00 2001 From: s-arika Date: Fri, 8 Nov 2019 08:58:16 -0500 Subject: [PATCH 2/8] changes for config --- config/config.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/config/config.js b/config/config.js index 5fcb47e2ff..5a55306a86 100644 --- a/config/config.js +++ b/config/config.js @@ -5,4 +5,6 @@ dotenv.config(); module.exports = { port: process.env.PORT, env: process.env.NODE_ENV, + user: process.env.NODEMAILER_USERNAME, + pass: process.env.NODEMAILER_PASSWORD, }; From 49f23717ee25128f5c7dc9483693d9e3701bfc1f Mon Sep 17 00:00:00 2001 From: Sarika Hanif Date: Fri, 8 Nov 2019 09:43:57 -0500 Subject: [PATCH 3/8] Update .env.example --- .env.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.env.example b/.env.example index aadcdd5415..aad190cd57 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,4 @@ NODE_ENV=development PORT=8080 NODEMAILER_USERNAME= -NODEMAILER_PASSWORD= \ No newline at end of file +NODEMAILER_PASSWORD= From 619581bd68d516d8447d694a36f85978e66dd7d9 Mon Sep 17 00:00:00 2001 From: Sarika Hanif Date: Fri, 8 Nov 2019 11:25:53 -0500 Subject: [PATCH 4/8] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 51768dabaf..c023c6f0f3 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,6 +28,9 @@ An easier solution would be to use Docker. **Setup** 1. Navigate to the root directory of telescope. +1. Create a new file and name it ".env". +1. Copy the contents of "env.example" into ".env". +1. Replace default key values in ".env" with credentials. 1. Run `npm install`. 1. Run `npm start` to start telescope. *If you get a series of errors, you may have to start redis-server depending on your installation configuration, do this by running the command `redis-server` in a seperate command window).* From 5495bf98c8caf0a34ef9fb795a0e0cf54b81e5b3 Mon Sep 17 00:00:00 2001 From: s-arika Date: Fri, 8 Nov 2019 11:42:10 -0500 Subject: [PATCH 5/8] changed .env name, comments in .env and delete config folder --- .env.example | 4 ---- config/config.js | 10 ---------- env.example | 11 +++++++++++ 3 files changed, 11 insertions(+), 14 deletions(-) delete mode 100644 .env.example delete mode 100644 config/config.js create mode 100644 env.example diff --git a/.env.example b/.env.example deleted file mode 100644 index aadcdd5415..0000000000 --- a/.env.example +++ /dev/null @@ -1,4 +0,0 @@ -NODE_ENV=development -PORT=8080 -NODEMAILER_USERNAME= -NODEMAILER_PASSWORD= \ No newline at end of file diff --git a/config/config.js b/config/config.js deleted file mode 100644 index 5a55306a86..0000000000 --- a/config/config.js +++ /dev/null @@ -1,10 +0,0 @@ -const dotenv = require('dotenv'); - -dotenv.config(); - -module.exports = { - port: process.env.PORT, - env: process.env.NODE_ENV, - user: process.env.NODEMAILER_USERNAME, - pass: process.env.NODEMAILER_PASSWORD, -}; diff --git a/env.example b/env.example new file mode 100644 index 0000000000..e1d2a032f8 --- /dev/null +++ b/env.example @@ -0,0 +1,11 @@ +# NODE_ENV should be one of "development" or "production" +NODE_ENV=development + +# PORT is the port used by the web server +PORT=8080 + +# NODEMAILER_USERNAME is sender's username credential +NODEMAILER_USERNAME= + +# NODEMAILER_PASSWORD is sender's password credential +NODEMAILER_PASSWORD= \ No newline at end of file From 8e37d2d4e7c7da5d935d7e5ce853093ca55d401c Mon Sep 17 00:00:00 2001 From: Sarika Hanif Date: Fri, 8 Nov 2019 11:53:00 -0500 Subject: [PATCH 6/8] Update env.example --- env.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/env.example b/env.example index e1d2a032f8..d263a1738c 100644 --- a/env.example +++ b/env.example @@ -8,4 +8,4 @@ PORT=8080 NODEMAILER_USERNAME= # NODEMAILER_PASSWORD is sender's password credential -NODEMAILER_PASSWORD= \ No newline at end of file +NODEMAILER_PASSWORD= From 423dbb1f56852e54fd06727b1d46b64501b702b9 Mon Sep 17 00:00:00 2001 From: s-arika Date: Fri, 8 Nov 2019 14:08:39 -0500 Subject: [PATCH 7/8] changes for contributing, env and config --- docs/CONTRIBUTING.md | 5 ++--- env.example | 6 ------ src/config.js | 3 +++ 3 files changed, 5 insertions(+), 9 deletions(-) create mode 100644 src/config.js diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c023c6f0f3..d42d1f5129 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,9 +28,8 @@ An easier solution would be to use Docker. **Setup** 1. Navigate to the root directory of telescope. -1. Create a new file and name it ".env". -1. Copy the contents of "env.example" into ".env". -1. Replace default key values in ".env" with credentials. +1. Copy env.example to .env to create a new environment configuration. +1. Replace default key values in .env with credentials. 1. Run `npm install`. 1. Run `npm start` to start telescope. *If you get a series of errors, you may have to start redis-server depending on your installation configuration, do this by running the command `redis-server` in a seperate command window).* diff --git a/env.example b/env.example index e1d2a032f8..b9522af0a8 100644 --- a/env.example +++ b/env.example @@ -3,9 +3,3 @@ NODE_ENV=development # PORT is the port used by the web server PORT=8080 - -# NODEMAILER_USERNAME is sender's username credential -NODEMAILER_USERNAME= - -# NODEMAILER_PASSWORD is sender's password credential -NODEMAILER_PASSWORD= \ No newline at end of file diff --git a/src/config.js b/src/config.js new file mode 100644 index 0000000000..c72f217abc --- /dev/null +++ b/src/config.js @@ -0,0 +1,3 @@ +const dotenv = require('dotenv'); + +dotenv.config(); \ No newline at end of file From 15da30a412a5bdf36fff14d8b926145ea6a83e5e Mon Sep 17 00:00:00 2001 From: Sarika Hanif Date: Fri, 8 Nov 2019 14:10:46 -0500 Subject: [PATCH 8/8] Update config.js --- src/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/config.js b/src/config.js index c72f217abc..4ca624acf4 100644 --- a/src/config.js +++ b/src/config.js @@ -1,3 +1,3 @@ const dotenv = require('dotenv'); -dotenv.config(); \ No newline at end of file +dotenv.config();