BuboJs is a library to build quickly and efficiently a Rest API, it is based on NodeJS, written entirely in Typescript and using ESModules. Main Features:
- Automatic route building with a direct link to the database (PostGres)
- Integrated role management tools
- File upload and download tools (firebase)
- Route validation tools
Install modules using lerna bootstrap to centralize all modules in root node_modules.
lerna bootstrapIt's necessary to build ts files into js files to execute them This command remove previous build dir and build them with tsc compiler
yarn buildJest run all *.test.ts files in packages/* dir
yarn testTo start the server you must instantiate an HttpAdapter (currently only tinyhttp is available) Then to actually start the server you have to pass this instance and the options you need to the app.initHttpModule()
example:
import { TinyHttpAdapter } from '@bubojs/tinyhttp'
import { app, AppOptions } from '@bubojs/api'
export const startServer = () => {
return new Promise(async (resolve, reject) => {
try {
const adapter = new TinyHttpAdapter()
const appOptions: AppOptions = {
errorMiddleware: (err: any, req: any, res: any, next?: Function) => {
console.log('Caught Server Error ', err)
res.status(500).json(err)
},
port: 3000
}
const server = await app.initHttpModule(adapter, appOptions)
resolve(server)
} catch (err) {
reject(err)
}
})
}To manage authentication currently only JWT is available but you can add your authentication system and others will be added later
For the rights, the library role-acl is used
You can define your own middlewares, they can be called before or after the execution of the route, for the middlewares that run after the route there is no need to send the result, this can be done automatically because bubo adds itself a last middleware that returns what is in req.result
The middlewares are executed in the same order as they are added in the code (the highest one above the route will be executed first)
TODO
TODO
