README
4Crud
VERY SMALL (7kb) and fast Node.js module for API development written with ES6 features.
Getting Started
A fast and VERY SMALL Node.js framework for API development written with javascript ES6 features.
Prerequisites
- nodejs 12.x +
Installing
npm install 4crud --save
Testing
This project uses Mocha-Chai combination in /test folder
npm test
Features
- Routing
- Fast performance (Remember, ES6 have some intrinsic slowdowns but yes, it's fastest as express.js!)
- Fast implementation on any type of API
- Very small (just 7 KB!)
Example
const Server = require('4crud')
const server = new Server()
server
// curl localhost:3000/getroute1?name=john
.get('/getroute1', (req, res) => {
console.log(`method: ${req.method} on route 1 with name: ${req.search.get('name')}`)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(req.url))
})
.get('/getroute2', (req, res) => {
console.log(`method: ${req.method} on route 2`)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(req.url))
})
.put('/putroute1', (req, res) => {
console.log(`method: ${req.method}`)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(req.body))
})
// curl -X POST -H "Content-Type: application/json" -d '{"name":"john","password":"abc"}' localhost:3000/postroute1
.post('/postroute1', (req, res) => {
console.log(`method: ${req.method} on POST route 1 with name ${req.body.name}`)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(req.body))
})
.post('/postroute2', (req, res) => {
console.log(`method: ${req.method}`)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(req.body))
})
.delete('/deleteroute1?name=john01', (req, res) => {
console.log(`method: ${req.method} on route 1`)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(req.body))
})
.start(3000) // start server at port 3000
Express.js comparison
Run on your preferred CLI on /test folder with server on:
wrk -t8 -c100 -d30s http://localhost:3000/getroute1
Framework | Requests/second | Size(kB) |
---|---|---|
4crud | 19808.47 | 200 |
Express | 19761.31 | 7 |
Running
npm start
Release History
- 0.0.1
- CHANGE: Work in progress
- 0.1.0
- Basic routing implemented
Authors
- GH3S - Initial work - gh3s@protonmail.ch
License
This project is licensed under the MIT License - see the LICENSE file for details
Contributing
- Fork it (https://github.com/gh3s/4crud/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request