document environment variables

adam-coster · Apr 25, 2018 · 5c2f2cf · 5c2f2cf
1 parent 20d301f
commit 5c2f2cf
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,4 @@
+  GH_TOKEN=
+  REDIS_URL=
+  PORT=
+  CACHE_TTL=
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+.env
+.npmrc
 node_modules
 .nyc_output
 example/dist

diff --git a/bin/update-server.js b/bin/update-server.js
@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+require('dotenv-safe').load()
+
 'use strict'
 
 process.title = 'update-server'

diff --git a/index.js b/index.js
@@ -1,5 +1,7 @@
 'use strict'
 
+require('dotenv-safe').load()
+
 const http = require('http')
 const fetch = require('node-fetch')
 const semver = require('semver')

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
     "test": "prettier-standard '**/*.js' && standard && NODE_ENV=test nyc tap test/*.js"
   },
   "dependencies": {
+    "dotenv-safe": "^5.0.1",
     "ms": "^2.1.1",
     "node-fetch": "^2.1.1",
     "redis": "^2.8.0",

diff --git a/test/index.js b/test/index.js
@@ -1,5 +1,7 @@
 'use strict'
 
+require('dotenv-safe').load()
+
 const { test } = require('tap')
 const fetch = require('node-fetch')
 const Updates = require('..')