https://github.com/nadeesha/grizzly

A node based REST API for demonstrating all around best practices.
https://github.com/nadeesha/grizzly

Last synced: 4 days ago
JSON representation

A node based REST API for demonstrating all around best practices.

• Host: GitHub
• URL: https://github.com/nadeesha/grizzly
• Owner: nadeesha
• Created: 2013-09-03T16:51:17.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-03T17:23:08.000Z (about 11 years ago)
• Last Synced: 2024-04-14T07:10:39.559Z (7 months ago)
• Size: 121 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
grizzly

=======

A node based REST API for demonstrating all around best practices in node development. This application demonstrates the usage of following modules.

*  Using [express](http://expressjs.com/) for REST API development

* Using [passport](http://passportjs.org/) for authenticating and securing the API ([token-based](https://github.com/jaredhanson/passport-http-bearer) and [local](https://github.com/jaredhanson/passport-local) strategies)

* Database modeling with [Mongoose](http://mongoosejs.com/)

* Logging with [Winston](https://github.com/flatiron/winston)

* E-mail connectivity with [nodemailer](https://github.com/andris9/Nodemailer)

* Testing the API with [Mocha](https://github.com/visionmedia/mocha)

installation

============

1. Clone the repo and install the dependencies by running `npm install` within the cloned directory.

2. Be sure to change the configurations within the `config/config.js`.

running

=======

`node server.js`

testing

=======

* `make test` for test execution

* `make test-w` to establish a watch on the test suites

acknowledgements

================

The excellent [node-express-mongoose-demo](https://github.com/madhums/node-express-mongoose-demo) by [madhums](https://github.com/madhums)