FawkesJs

FawkesJs is a Javascript framework that is built on top of express, typescript and MVC structure. Inspired by Laravel and Loopback, the target of the framework is to make Javascript development even easier.

System Requirement

• Nodejs 7.6 or above (for the default support of async await)

Usage

git clone https://github.com/fawkesjs/fawkesjs-starter
cd fawkesjs-starter
npm install
npm run start # swagger at http://localhost:5000/swagger

open another console and run following command to have auto restart

npm run watch

Common Command

• Generating Swagger: npm run swagger
• Full Migrate DB: npm run db:sync
• Restart App: node . or nodemon ./index.js -e ts --watch app

TODO

• Remove the usage of most class with static function for better dependency injection

For performance critical app, you might find that the latest hyperium/hyper is more suitable for you.

Build in structure in this project

• Express
• Sequelize
• Typescript
• Swagger: use fawkesjs -s ./swagger/swagger.json to generate swagger document
• Express Rest Param Validation: integration with swagger document generation
• Acl (inside fawkesjs-starter/app/module)
• AccessToken (inside fawkesjs-starter/app/module)

Resources

• Starter
• Documentation