Skip to content

Latest commit

 

History

History
executable file
·
72 lines (50 loc) · 2.26 KB

README.md

File metadata and controls

executable file
·
72 lines (50 loc) · 2.26 KB

RestfulNode

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

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:-

We use the passport-localapikey-update module to secure our app via a static apiKey. For more info https://www.npmjs.com/package/passport-localapikey-update We store our apikey within the app/Config/Config.js

Installation and Run

  1. Clone the repositary
git clone https://github.com/jumacro/RestfulNode YourProjectName
  1. Go to your project root. Run the package installer
npm install

  1. Go to YourProjectName >> app >> Config and open the Config.js file. Change the credentials as per your requirement. Change the apikey as per your project.

  2. Run the application as:-

npm start

POSTMAN test

N.B. POSTMAN is a crome extension for Api testing.

On POSTMAN put http://localhost:3000/api/v1.0/ as URL Choose "GET" Click on Headers tab, and pass the apikey via the header. The apikey should match with the apikey you stored in your app/Config/Config.js file.

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 :)