Skip to content

Latest commit

 

History

History
executable file
·
77 lines (54 loc) · 3.67 KB

README.md

File metadata and controls

executable file
·
77 lines (54 loc) · 3.67 KB
Raw

NOMinatr

This is the primary codebase that powers nominatr.com, a site that provides a quick and easy way for groups of people to vote on a restaurant for a particular event.

Prerequisites

  • Node.js - Download and Install Node.js. You can also follow this gist for a quick and easy way to install Node.js and npm.
  • MongoDB - Download and Install MongoDB - Make sure it's running on the default port (27017).

Optional (Requirements for Grunt)

  • Ruby - Download and Install Ruby.
  • Ruby Gems - Download and Install Ruby Gems.
  • Compass - an open-source CSS Authoring Framework, install via Ruby Gems.
  • Grunt - Download and Install Grunt.

Additional Packages

  • Express - Defined as npm module in the package.json file.
  • Mongoose - Defined as npm module in the package.json file.
  • Passport - Defined as npm module in the package.json file.
  • AngularJS - Defined as bower module in the bower.json file.
  • Twitter Bootstrap - Defined as bower module in the bower.json file.
  • UI Bootstrap - Defined as bower module in the bower.json file.

Quick Install

To set up your own instance of NOMinatr, simply install Node.js and MongoDB (see Prerequisites above), and then install the dependencies:

$ npm install

Export the node Path to load your lib into project (default in HEROKU) $ export NODE_PATH=lib

We recommend using Grunt to start the server: $ grunt

When not using grunt you can use:

$ node server

Then open a browser and go to:

http://localhost:3000

Quick Deployment

4 commands to deploy your mean app to heroku, Before you start make sure you have heroku toolbelt installed and an accessible mongo db instance - you can try mongohq which have an easy setup )

git init
git add .
git commit -m "initial version"
heroku apps:create
git push heroku master

Configuration

All configuration is specified in the config folder, particularly the config.js file. Here you will need to specify your application name, database name, as well as hook up any social app keys if you want integration with Twitter, Facebook, GitHub or Google.

Environmental Settings

There are three environments provided by default, development, test, and production. Each of these environments has the following configuration options:

  • db - This is the name of the MongoDB database to use, and is set by default to mean-dev for the development environment.
  • root - This is determined automatically at the start of this file, but can be overridden here.
  • app.name - This is the name of your app or website, and can be different for each environment. You can tell which environment you are running by looking at the TITLE attribute that your app generates.
  • Social Registration - Facebook, GitHub, Google, Twitter. You can specify your own social accounts here for each social platform, with the following for each provider:
    • clientID
    • clientSecret
    • callbackURL

To run with a different environment, just specify NODE_ENV as you call grunt:

$ NODE_ENV=test grunt

If you are using node instead of grunt, it is very similar:

$ NODE_ENV=test node server

NOTE: Running Node.js applications in the production environment enables caching, which is disabled by default in all other environments.