Pass information on the web - that evaporates when accessed
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
client
config
gulp
handlers
helpers
middleware
models
modules
routes
services
setup
.gitignore
LICENSE
README.md
app.js
gulpfile.js
package.json

README.md

Volatile

Introduction:

Pass information that evaporates when accessed

volatile

Built with:

Testing:

Dependencies:

Install dependencies:

  • brew/apt-get install nodejs
  • brew/apt-get install redis
  • brew/apt-get install mongodb
  • npm install -g mocha
  • npm install -g gulp
  • npm install

Environment variables:

  • PORT - Port exposed by this component.
  • example: 3000
  • DEBUG - Debug output (* for all) (optional)
  • example: *
  • DOMAIN - The domain your app is currently residing on
  • example: localhost:3000 or someapp.herokuapp.com
  • NODE_ENV - Environment ('development', 'staging', 'production')
  • example: development
  • CLIENT_API_PATH - Path to the client REST api (relative)
  • example: /api
  • APPSECRET - Application session secret
  • example: sOmeCrAzYhAsH894372
  • SESSION_KEY - Application session secret (optional)
  • example: express.sid (defaults to connect.sid)
  • REDIS_URL - Redis url (including authentication)
  • example: redis://user:pass@localhost:6379
  • REDIS_DB - Redis database number (optional)
  • example: 1
  • REDIS_SESSION_PREFIX - Prefix for redis session entries (optional)
  • example: sess:
  • MONGO_URL - MongoDB url (including authentication)
  • example: mongodb://user:pass@localhost:27017/mydatabase

Run tests:

  • npm test or mocha -R spec

Run the application:

  • set environment variables
  • gulp
  • (create a shellscript with the above for convenience if you want)
  • navigate your browser to http://localhost:3000 (or whatever port you chose for PORT)

Development shellscript example:

#!/bin/sh
export PORT=3000 \
export DEBUG="*" \
export DOMAIN="localhost:3000"
export NODE_ENV="production" \
export APPSECRET="somecrazyhash" \
export CLIENT_API_PATH="/api" \
export SESSION_KEY="express.sid" \
export MONGO_URL="mongodb://localhost/volatile" \
export REDIS_URL="redis://localhost:6379" \

gulp