aboutsummaryrefslogtreecommitdiff
path: root/config
diff options
context:
space:
mode:
authorRubén Beltrán del Río <ben@nsovocal.com>2017-02-18 17:55:13 -0600
committerGitHub <noreply@github.com>2017-02-18 17:55:13 -0600
commit5e981bca19ace2a7704f267175b6aa368e63bda0 (patch)
treed38e6cbd1762837d3fae81b5029a9c0b48fa08b4 /config
parentdc10b1de1a73effd6d0ab5744709913ef5cbe5b3 (diff)
Initial Setup (#1)
* Add git ignore * Add eslint config * Add dummy project files * Add jsdoc config * Add docker files * Add changelog, contributing and readme * Add travis files * Add Paw helper * Add travis test docker compose file * Name the ci service appropriately
Diffstat (limited to 'config')
-rw-r--r--config/config.js18
-rw-r--r--config/env.dist0
-rw-r--r--config/jsdoc.json9
3 files changed, 27 insertions, 0 deletions
diff --git a/config/config.js b/config/config.js
new file mode 100644
index 0000000..5b29ec4
--- /dev/null
+++ b/config/config.js
@@ -0,0 +1,18 @@
+'use strict';
+
+const Getenv = require('getenv');
+
+const internals = {};
+
+/**
+ * The main configuration object for Dead Drop. It will be used to
+ * initialize all of the sub-components. It can extend any property of
+ * the dead drop object.
+ *
+ * @memberof DeadDrop
+ * @typedef {object} tConfiguration
+ * @property {number} [port=1988] the port where the app will listen on
+ */
+module.exports = internals.Config = {
+ port: Getenv.int('DEAD_DROP_PORT', 1988)
+};
diff --git a/config/env.dist b/config/env.dist
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/config/env.dist
diff --git a/config/jsdoc.json b/config/jsdoc.json
new file mode 100644
index 0000000..9e05753
--- /dev/null
+++ b/config/jsdoc.json
@@ -0,0 +1,9 @@
+{
+ "plugins": ["plugins/markdown"],
+ "opts": {
+ "destination": "doc",
+ "readme": "README.md",
+ "template": "node_modules/docdash",
+ "recurse": true
+ }
+}