From 5e981bca19ace2a7704f267175b6aa368e63bda0 Mon Sep 17 00:00:00 2001 From: Rubén Beltrán del Río Date: Sat, 18 Feb 2017 17:55:13 -0600 Subject: 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 --- config/config.js | 18 ++++++++++++++++++ config/env.dist | 0 config/jsdoc.json | 9 +++++++++ 3 files changed, 27 insertions(+) create mode 100644 config/config.js create mode 100644 config/env.dist create mode 100644 config/jsdoc.json (limited to 'config') 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 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 + } +} -- cgit