# crudify-mongoose

> Generates CRUD routes for a given Mongoose model.

Latest version **0.2.0** (published 2015-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install crudify-mongoose
pnpm add crudify-mongoose
yarn add crudify-mongoose
bun add crudify-mongoose
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-01-07 |
| First published | 2014-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+12 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Josh Sephton |
| Maintainers | heldtogether |

## Links

- npm: https://www.npmjs.com/package/crudify-mongoose
- Repository: https://github.com/heldtogether/crudify-mongoose
- Issues: https://github.com/heldtogether/crudify-mongoose/issues
- npm.io page: https://npm.io/package/crudify-mongoose

## Dependencies (5)

- [ejs](https://npm.io/package/ejs.md) *
- [express](https://npm.io/package/express.md) ^3.0.0
- [mongoose](https://npm.io/package/mongoose.md) ^3.0.0
- [pluralize](https://npm.io/package/pluralize.md) ^0.0.10
- [underscore](https://npm.io/package/underscore.md) ^1.0.0

## Recent versions

- 0.2.0 (latest) — 2015-01-07
- 0.1.0 — 2015-01-07
- 0.0.8 — 2014-07-22
- 0.0.7 — 2014-07-21
- 0.0.6 — 2014-07-16
- 0.0.5 — 2014-07-07
- 0.0.4 — 2014-07-06
- 0.0.3 — 2014-07-06
- 0.0.2 — 2014-07-06
- 0.0.1 — 2014-07-06

## README

crudify-mongoose
============

Simple generator to create RESTful url routes, render forms and handle Create, Read, Update and Delete requests for a given Mongoose model

## Install

```bash
$ npm install crudify-mongoose
```

## RESTful routes

Generate RESTful url routes for the Mongoose model supplied.
You should use the pluralized name of the model in place of
`{resources}`. 

```js
module.exports = mongoose.model('user', userSchema); // {resources} == 'users'
```

URL routes:

- GET /{resources}/
- GET /{resources}/create/
- POST /{resources}/
- GET /{resources}/{id}/
- GET /{resources}/{id}/edit/
- PUT /{resources}/{id}/
- DELETE /{resources}/{id}/

## Usage

```js
/**
 * @param {Object} options
 * @param {Object} options.model
 *		  - A Mongoose model of the resource you want 
 *          to CRUDify.
 * @param {String} [options.theme] 
 *		  - The locacation of the views to render. 
 *          There are default forms which require your 
 *          app to use EJS view engine.
 * @param {Array} [options.middleware]
 *		  - An array of middleware you want to use for 
 *          each route. You can add authentication in 
 *          this way (none is used by default).
 * @param {Array} [options.ignoredProperties] 
 *		  - The model properties which you don't want 
 *          to see. By default this list is ['_id', '__v'].
 */

crudGenerator(options);
```

## Example

```js
var crudGenerator = require('crudify-mongoose');
var userModel = require('./model/user');

/**
 * Generate routes and controller methods
 * for the users resources:
 *     - GET /admin/users/
 *     - GET /admin/users/create/
 *     - POST /admin/users/
 *     - GET /admin/users/{id}/
 *     - GET /admin/users/{id}/edit/
 *     - PUT /admin/users/{id}/
 *     - DELETE /admin/users/{id}/
 */
app.use('/admin', crudGenerator({
	model: userModel,
	middleware: [
		function (res, req, next){
			console.log('middle');
			next();
		}
	],
	ignoredProperties: ['__v', '_id', 'modifiedAt']
}));
```

## Todo

- Modify to accept multiple models in one call to `app()`.
- Listen to `Accept:` header or file extension to determine whether to send HTML or encoded (e.g. JSON) responses.
- Make Create/Edit forms smart enough to allow you to pick a relation from a list where appropriate.
- Make Create/Edit forms smart enough to allow you to supply an array where appropriate.


## License

The MIT License (MIT)

Copyright (c) 2014 Josh Sephton

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/crudify-mongoose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._