1.0.1 • Published 4 years ago

@rampung/hebat v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
4 years ago

HEBAT - Hapi Enterprise Base Application in Typescript

HEBAT is a framework built in house to take care of the base of any enterprise web applications and let you focus on what matters to your application.

Highlights:

  • Written in Typescript for strong type checking
  • Uses React as our front-end framework for component reusability
  • Uses Node.js and Javascript for both server and client side language to easily work on both spectrums of the application
  • Built on top of people favorite web framework Hapi.js
  • Tests coverage on core logic

Builds

  • .d.ts will be generated through npm run build:dts
  • lib built files will be generated through npm run build:dev

Engine API

  • Hebat({ server: { host, port }, database: { hostname, port, dbName, username, password }, frontEnd: { publicPath, clientEntryName }, auth?: { loginPath, password }, logging: { printToStdout, fileName, level } })
  • server
    • host: string - Server's hostname
    • port: number - Server's port number
  • database
    • hostName: string - Database hostname
    • port: number - Database port number
    • dbName: string - Database name
    • userName: string - Database username
    • password: string - Database password
  • frontEnd
    • publicPath: string - Public path
    • clientEntryName: string - Client entry name that is used identify an application in Webpack
  • auth
    • loginPath: string - Login path
    • password: string - Cookie password
  • logging
    • printToStdout: boolean - Print output to stdout?
    • fileName: string - Log file name
    • level: string - Minimum log level to be logged

Dev Notes:

  • Using the generated .d.ts files obfuscate the code implementation. Whereas, using the .ts will direct you to go directly to the implementation code.
  • To make transpiling faster, set ts-loader to only transpile code, by using this option transpileOnly: true. And run the type checker using the fork-ts-checker-webpack-plugin plugin in the Webpack. The downside is that you have to emit declaration in a separate process like, tsc --emitDeclarationOnly --watch