eMarket
DataBase Class Project.
Docs
Links to docs go here.
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.
- Grunt - grunt-cli
- Make sure you install grunt-cli globally using
npm install -g grunt-cli.
Quick Install
The quickest way to get started with eMarket is to utilize it like this:
Clone & Run:
git clone https://github.com/vjames19/eMarket.git
cd eMarket
npm install
grunt
We recommend using Grunt to start the server:
grunt
Then open a browser and go to:
http://localhost:9000
Configuration
All configuration is specified in the config folder, particularly the config.js file.
Environmental Settings
To run with a different environment, just specify NODE_ENV as you call grunt:
$ NODE_ENV=test grunt
Code Style
We enforce the following general settings:
indent_style = space
indent_size = 2
continuation_indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
We use the following JavaScript Style Guide as our JS coding standards.
Contributing
TODO: Specify commiting rules and format.
