Express 4.x application with Passport authentication

Introduction:

This project will give you a complete scaffolding/boilerplate of the node/express stack along with social logins through passport and email verification through mandrill. It uses mongodb for database models and redis for session storage. Fork at will! :)

Built with:

• node.js
• express
• passport
• gulp
• socket.io
• convict
• browserify
• envify
• reactify
• react
• handlebars
• stylus
• nib
• bootstrap
• fontawesome
• jquery

Testing:

• mocha
• chai
• sinon

Dependencies:

• nodejs
• mongodb
• redis

Social logins supported:

• facebook
• google+
• instagram
• (only by linking - as Instagram might not supply a valid email for registration)

Install dependencies (some might need to use sudo for various reasons):

• 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

Create an application on both Facebook, Google+ and Instagram and point the callbacks to (respectively):

• http://localhost:3000/auth/facebook/callback
• http://localhost:3000/auth/google/callback
• http://localhost:3000/auth/instagram/callback

Email verification via Mandrill:

• Create an application on mandrill

Environment variables:

• PORT - Port exposed by this component.
• example: 3000
• SERVICE_NAME - The name of your fantastic service/platform!
• example: Express Passport Application
• DEBUG - Debug output (* for all) (optional)
• example: *
• NODE_ENV - Environment ('development', 'staging', 'production')
• example: development
• CLIENT_API_PATH - Path to the client REST api (relative)
• example: /api
• CLIENT_DOMAIN - Server domain
• example: localhost or someapp.herokuapp.com
• MONGO_URL - MongoDB url (including authentication)
• example: mongodb://user:pass@localhost:27017/mydatabase
• REDIS_URL - Redis url (including authentication)
• example: redis://user:pass@localhost:6379
• REDIS_DB - Redis database number (0-15)
• example: 1 - defaults to 0
• REDIS_SESSION_PREFIX - Prefix for redis session entries (optional)
• example: sess:
• APPSECRET - Application session secret
• example: sOmeCrAzYhAsH894372
• SESSION_KEY - Application session secret (optional)
• example: express.sid (defaults to connect.sid)
• FACEBOOK_CLIENT_ID - Facebook application client id
• example: abcdefghijklmnopqrstuvxyz1234567890
• FACEBOOK_CLIENT_SECRET - Facebook application client secret
• example: abcdefghijklmnopqrstuvxyz1234567890
• FACEBOOK_CALLBACK_URL - Facebook application callback url
• example: http://yourdomain.com/auth/facebook/callback
• GOOGLE_CLIENT_ID - Google application client id
• example: abcdefghijklmnopqrstuvxyz1234567890
• GOOGLE_CLIENT_SECRET - Google application client secret
• example: abcdefghijklmnopqrstuvxyz1234567890
• GOOGLE_CALLBACK_URL - Google application callback url
• example: http://yourdomain.com/auth/google/callback
• INSTAGRAM_CLIENT_ID - Instagram application client id
• example: abcdefghijklmnopqrstuvxyz1234567890
• INSTAGRAM_CLIENT_SECRET - Instagram application client secret
• example: abcdefghijklmnopqrstuvxyz1234567890
• INSTAGRAM_CALLBACK_URL - Instagram application callback url
• example: http://yourdomain.com/auth/instagram/callback
• MANDRILL_API_KEY - Mandrill API key
• example: abcdefghijklmnopqrstuvxyz1234567890
• MANDRILL_SENDER - Mandrill email sender address
• example: John Doe <[email protected]>
• EMAIL_VERIFICATION_ROUTE - Email verification route
• example: http://yourdomain.com/auth/local/verify

Run tests:

• npm test

Run the application:

• set environment variables
• gulp
• alternatively create a shellscript for the above (for development)
• navigate your browser to http://localhost:PORT

Development shellscript example:

#!/bin/sh
export PORT=3000 \
export SERVICE_NAME="Express Passport Application" \
export DEBUG="*,-engine:polling" \
export NODE_ENV="development" \
export CLIENT_DOMAIN="localhost" \
export CLIENT_API_PATH="/api" \
export MONGO_URL="mongodb://localhost/express-passport-app" \
export REDIS_URL="redis://localhost:6379" \
export REDIS_DB=0 \
export REDIS_SESSION_PREFIX="sess:" \
export APPSECRET="somecrazyhash" \
export SESSION_KEY="express.sid" \
export FACEBOOK_CLIENT_ID="000000000000000" \
export FACEBOOK_CLIENT_SECRET="000000000000000000000000000000000000000000000" \
export FACEBOOK_CALLBACK_URL="http://localhost:3000/auth/facebook/callback" \
export GOOGLE_CLIENT_ID="000000000000000000000000000000.apps.googleusercontent.com" \
export GOOGLE_CLIENT_SECRET="000000000000000000000000000000" \
export GOOGLE_CALLBACK_URL="http://localhost:3000/auth/google/callback" \
export INSTAGRAM_CLIENT_ID="000000000000000000000000000000" \
export INSTAGRAM_CLIENT_SECRET="000000000000000000000000000000" \
export INSTAGRAM_CALLBACK_URL="http://localhost:3000/auth/instagram/callback" \
export MANDRILL_API_KEY="000000000000000000000000000000" \
export MANDRILL_SENDER="Express Passport Application <[email protected]>" \
export EMAIL_VERIFICATION_ROUTE="http://localhost:3000/auth/local/verify" \

gulp develop

TODO

• upgrade to socket.io 1.x
• continuous integration with travis
• add test coverage with coveralls.io
• add unit test framework
• look into using jest for testing
• add complete test suite
• replace jquery with react or mithril
• build simple client side example with the selected framework
• use material ui instead of bootstrap