jiniadn / restfulnode

This repositary is an effort to create a easy to use production ready framework for node.js using it as a RESTFUL API build with Oauth token

RestfulNode

This repositary is an effort to create an easy to use production ready framework for node.js using it as a RESTFUL API.

Technologies:-

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. SequilizeJs --- We are using MySQL for the Api db. Squelizejs is a very good ORM written for nodejs with a lot many features. See http://www.docs.sequelizejs.com for more information.

How to run:-

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.

Then follow the expressjs documentation and install expressjs and the express-generator

Clone the repositary

git clone https://github.com/jumacro/RestfulNode YourProjectName

Go to your project root. Run the package installer

npm install

Rename app.js.sample to app.js and set up your project credentials as per your need.

Set up your database as per the schema structure residing on the schema folder -> app/Model/Schema

Copy Config.js.sample from config folder residing at app/Config and rename to Config.js. Change the credential to your comfort. Run the application as:-

npm start

Browse your api as http://localhost/api/v1.0

Production trick

Install forever.js. Its a easy to way to keep your node app persistant. Follow the bellow blog for more information:- http://blog.nodejitsu.com/keep-a-nodejs-server-up-with-forever/

Happy Coding :)