Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glorious-codes/glorious-crud
A bare minimum and extensible crud generator
https://github.com/glorious-codes/glorious-crud
crud-generator expressjs javascript mongodb nodejs
Last synced: 6 days ago
JSON representation
A bare minimum and extensible crud generator
- Host: GitHub
- URL: https://github.com/glorious-codes/glorious-crud
- Owner: glorious-codes
- Created: 2018-04-27T12:44:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-05T19:43:38.000Z (over 5 years ago)
- Last Synced: 2024-11-03T17:02:44.948Z (12 days ago)
- Topics: crud-generator, expressjs, javascript, mongodb, nodejs
- Language: JavaScript
- Homepage: https://glorious.codes/crud
- Size: 157 KB
- Stars: 45
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Glorious Crud
> A bare minimum and extensible crud generator.
[](https://circleci.com/gh/glorious-codes/glorious-crud/tree/master)
[](https://codecov.io/gh/rafaelcamargo/glorious-crud)
## Installation
```
npm install @glorious/crud --save
```
## Usage
### Basic
The purpose of this lib is to remove all the effort involved in creating a default crud as well as keeping everything under your control through its options.
``` javascript
const express = require('express');
const GCrud = require('@glorious/crud');
const app = express();
const gCrud = new GCrud('databaseUrl', 'databaseName', app);
// The line below will make the following endpoints available:
// GET /beers
// GET /beers/:id
// POST /beers
// PUT /beers/:id
// DELETE /beers/:id
const beersResource = gCrud.build('beers');
// From here, you can add any other custom endpoint you need.
beersResource.get('/beers/:id/awards', (req, res) => {
// Your specific needs go here.
});
app.listen(9000, () => {
console.log(`Running on port 9000...`);
});
```
### Options
Using options, you can override any method by doing as follows:
``` javascript
const options = {
get: (req, res) => {
// This implementation will override get method.
// The same can be done for any other method:
// post, put, delete.
}
}
const beersResource = gCrud.build('beers', options);
```
You can also set listeners to be called *on success* or *on error* of some method:
``` javascript
const options = {
// Executes after every successful get request
onGetSuccess: (req, res, response) => {
// response is an object containing "status" (200) and "body".
},
// Executes after every failed get request
onGetError: (req, res, err) => {
// err is an object containing "status" (4xx or 5xx) and "body".
},
// Executes after every successful post request
onPostSuccess: (req, res, response) => {
// response is an object containing "status" (201) and "body".
},
// Executes after every failed post request
onPostError: (req, res, err) => {
// err is an object containing "status" (4xx or 5xx) and "body".
},
// Executes after every successful put request
onPutSuccess: (req, res, response) => {
// response is an object containing "status" (204).
},
// Executes after every failed put request
onPutError: (req, res, err) => {
// err is an object containing "status" (4xx or 5xx) and "body".
},
// Executes after every successful delete request
onDeleteSuccess: (req, res, response) => {
// response is an object containing "status" (204).
}
// Executes after every failed delete request
onDeleteError: (req, res, err) => {
// err is an object containing "status" (4xx or 5xx) and "body".
}
}
const beersResource = gCrud.build('beers', options);
```
### Built-in Query Params
When querying resources, you can use some built-in query params:
#### $sortBy
Sort some collection by one of its attributes:
```
curl http://localhost:9000/beers?$sortBy=name
```
#### $order
Order a sorted request by `asc` or `desc`:
```
curl http://localhost:9000/beers?$sortBy=name&$order=desc
```
#### $limit
Limit the number of results:
```
curl http://localhost:9000/beers?$limit=1
```
Also, you can use any resource attribute name as a filter:
```
curl http://localhost:9000/beers?name=Opa%20Bier
```
## Contributing
1. Install [Node](https://nodejs.org/en/). Download the "Recommend for Most Users" version.
2. Clone the repo:
``` bash
git clone [email protected]:glorious-codes/glorious-crud.git
```
3. Go to the project directory
``` bash
cd glorious-crud
```
4. Install the project dependencies
``` bash
npm install
```
6. run:
``` bash
node src/app.js
```
7. The API will be running on `http://localhost:9000`.
8. Make some request to see the API in action:
``` bash
curl http://localhost:9000/beers \
-H 'content-type: application/json' \
-d '{ "name":"Opa Bier" }'
```
**NOTE**
Check out below how to configure MongoDB on your machine before making any request to the API.
## Database
1. Install MongoDB following its website [instructions](https://docs.mongodb.com/manual/administration/install-community/).
2. Create a database called `gcrud`.
3. Create a collection called `beers`.
4. Start mongo on the default port(27017): Type `mongod` on your terminal.
## Tools
1. [Postman](https://www.getpostman.com/) is an awesome tool that makes API development a breeze.
2. [MongoDB Compass](https://www.mongodb.com/products/compass) is the prettiest MongoDB UI client I have ever seen.