express-boilerplate

A project scaffold intended for use with Express.js

This project is hosted: markdown-style-project-link

For exhaustive documentation, check out the project wiki

Please report any bugs or issues here

Installation instructions

• Install the latest edition of Node.js from here
• Install the latest version of MongoDB from here
• Install all dependencies with npm i --silent
• Create a file .env in the root directory with the following contents:

GOOGLE_ID=value
GOOGLE_KEY=value
TWITTER_ID=value
TWITTER_KEY=value
FACEBOOK_ID=value
FACEBOOK_KEY=value
EMAIL_PASSWORD=value
COOKIE_SECRET=randomsecretstring
SESSION_SECRET=randomsecretstring
MONGO=mongodb://127.0.0.1:27017/testDb

• Start the localhost mongod server via mongod
• Run the server locally at port 3000 or "PORT" in process.env with npm start
• View the website at localhost:3000 within your browser

Utility scripts:

• npm run archive: Creates a zip archive of the form <commit>-<branch>.zip in out/archive.
• npm run check: Checks for dependency updates using npm-check.
• npm run console: Starts an interactive console with the app and it's globals pre-loaded.
• npm run make-docs: Generates a project documentation manifest at out/docs/.
• npm run make-wiki: Generates a compiled project wiki at out/wiki/REFERENCE.md.
• npm run pack: Minifies static assets in public/*.

External Requirements:

• A MongoDB instance running locally or valid MONGO string in process.env
• Valid social authentication tokens in process.env
• A valid COOKIE_SECRET string in process.env for better security (Optional)
• A valid SENTRY_DSN token in process.env for Sentry error alerts (optional)