Installation

Pre-Requisites:-

1. ExpressJs --- Used to create the scaffold for the Framework. See http://wwww.expressjs.com for full documentation

2. PassportJs --- Used to create the Authentication system. See http://www.passportjs.org for documentation

3. Mongoose ORM --- We are using MongoDb for the Api db. Mongoose is a very good ORM written for nodejs with a lot many features. See http://www.mongoosejs.com/docs/guide.html for more information.

Nodejs

First you have to install nodejs and npm onto your machine. The Official Nodejs website https://nodejs.org/ has good tutorial about how to install them. Check out:- https://nodejs.org/download/

Expressjs

Then follow the expressjs documentation and install expressjs and the express-generator. Please use the -g command to install them globally. Like this :--

npm install express -g

And

npm install express-generator -g

MongoDB

To install MongoDb please follow the below URL:- http://docs.mongodb.org/manual/tutorial/install-mongodb-on-os-x/

Authentication:-

BASIC Auth username --> appKey password --> appSecret

You can find the information at server/Config.js

Installation and Run

1. Clone the repositary

git clone https://github.com/sahil87/sportscafe.git

2. Go to your project root. Run the package installer

npm install

4. Run the application as:-

npm start

Browse your api as http://localhost:3000/api/v1.0 you will see a welcome message.. This uri is unauthenticated to test whether my installation is correct..