Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 955 Bytes

README.md

File metadata and controls

19 lines (12 loc) · 955 Bytes

CRUDS

Build Status

CRUDS aims to provide a fast and easy way to create and expose mongodb collections for crud functionality through REST and websockets with optional real-time subscribe and unsubscribe functionality throught a websocket interface. CRUDS depends on express and socket.io to create the REST and Websocket endpoints. The REST is fully compatible with backbone.js models.

  1. Install with npm npm install cruds

  2. In your express app cruds = require("cruds")(<optional mongodb connection string>)

  3. Set endpoints with cruds.set(name, app?, socketio?)

More documentation can be found here.

A GIST on how to make CRUDS work with express and socket.io can be found here.