Skip to content

Commit

Permalink
Merge pull request #105 from s-arika/issue60
Browse files Browse the repository at this point in the history
Add .env File
  • Loading branch information
Sarika Hanif committed Nov 8, 2019
2 parents 5c27e1f + 15da30a commit af8e02c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ An easier solution would be to use Docker.

**Setup**
1. Navigate to the root directory of telescope.
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).*
Expand Down
5 changes: 5 additions & 0 deletions env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# NODE_ENV should be one of "development" or "production"
NODE_ENV=development

# PORT is the port used by the web server
PORT=8080
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
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
3 changes: 3 additions & 0 deletions src/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const dotenv = require('dotenv');

dotenv.config();

0 comments on commit af8e02c

Please sign in to comment.