Skip to content
FawkesJs is a Javascript framework that is built on top of express, typescript and MVC structure.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
doc
src
test
.editorconfig
.gitignore
LICENSE
index.js
package-lock.json
package.json
readme.md
tsconfig.json
tslint.json
typedoc.json

readme.md

NOTICE

This project is no longer under development, a combination of Koa with GraphQL can achieve a similar functionality.

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.

npm version Chat on Gitter

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

You can’t perform that action at this time.