Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/legitbaboulinet/blazeit.js
An extremely quick way to create a CRUD API out of a JS object
https://github.com/legitbaboulinet/blazeit.js
api crud express expressjs mongo mongodb mongoose mongoosejs nodejs quick server
Last synced: about 1 month ago
JSON representation
An extremely quick way to create a CRUD API out of a JS object
- Host: GitHub
- URL: https://github.com/legitbaboulinet/blazeit.js
- Owner: lucasmacori
- Created: 2019-02-21T19:19:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T15:33:38.000Z (9 months ago)
- Last Synced: 2024-10-07T21:04:43.779Z (about 1 month ago)
- Topics: api, crud, express, expressjs, mongo, mongodb, mongoose, mongoosejs, nodejs, quick, server
- Language: TypeScript
- Homepage:
- Size: 521 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**An extremely quick way to create a CRUD server out of a JS object**
# Installation
Before using BlazeIt.js, you will need a MongoDB server installed either on your computer, or a network accessible server.
If not, download it [here](https://www.mongodb.com/download-center/community).
Then, in a Node.js project. Install BlazeIt.js with the following command:
``` bash
npm install blazeit
```
# Usage
Here's how to create a BlazeIt.js instance.
``` javascript
const {Blazeit} = require('blazeit');
const myBlazeItServer = new Blazeit({
// Your settings here
// Report to the documentation
database: {
hostname: 'localhost',
name: 'test_blazeit',
},
models: {
person: {
firstName: String,
lastName: String,
birthDay: Date,
isMarried: Boolean,
numberOfChildren: Number
}
}
});
```
# Documentation
When calling BlazeIt.js, you have to pass it arguments.
Here are the possibilities:
- server
- port (default is 3000)
- express (an existing express instance. If not given, BlazeIt will generate one)
- bodyType (default is 'json', you can use 'json' or 'form')
- database
- hostname (default is localhost)
- port (default is mongoDB's default: 27017)
- name (default is 'Blazeit')
- models
BlazeIt.js relies on Mongoose's data types, you can use any of the available types.
Here's a list of those types:
- String
- Number
- Date
- Buffer
- Boolean
- Mixed
- ObjectId
- Array
- Decimal128
- Map
You can also create associations by defining the type as 'NAME_OF_ASSOCIATION'.\
Look below to see an example.
For more information, please visit the [offical Mongoose documentation](https://mongoosejs.com/docs/schematypes.html).
**Example**
Here's an example of a BlazeIt.js server with a list of Employees
``` javascript
const {Blazeit} = require('blazeit');
const myBlazeItServer = new Blazeit({
// Your settings here
// Report to the documentation
server: {
port: 3000
},
database: {
hostname: 'localhost',
port: 27017,
name: 'MyCompanyAPI',
},
models: {
employee: {
firstName: String,
lastName: String,
email: String,
phone: String,
jobDescription: String,
sector: 'sector'
},
sector: {
name: String,
manager: 'employee'
}
}
});
```
In this example, the following routes will be generated:
- GET localhost:3000/employee : Gets all the employees
- GET localhost:3000/employee/:id : Gets the employee with the given id
- POST localhost:3000/employee : Adds a new employee
- PUT localhost:3000/employee : Edits an existing employee
- DELETE localhost:3000/employee : Deleting an existing employee
- GET localhost:3000/sector : Gets all the sectors
- GET localhost:3000/sector/:id : Gets the sector with the given id
- POST localhost:3000/sector : Adds a new sector
- PUT localhost:3000/sector : Edits an existing sector
- DELETE localhost:3000/sector : Deleting an existing sector
# Information
BlazeIt.js is free of charge and can be modified and shared freely.
Although it comes with absolutely NO warranty whatsoever.
So please, be minded of that before starting any type of project with BlazeIt.js