1.0.1 • Published 6 years ago
@rampung/hebat v1.0.1
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.tswill be generated throughnpm run build:dtslib built fileswill be generated throughnpm 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 } })serverhost:string- Server's hostnameport:number- Server's port number
databasehostName:string- Database hostnameport:number- Database port numberdbName:string- Database nameuserName:string- Database usernamepassword:string- Database password
frontEndpublicPath:string- Public pathclientEntryName:string- Client entry name that is used identify an application in Webpack
authloginPath:string- Login pathpassword:string- Cookie password
loggingprintToStdout:boolean- Print output to stdout?fileName:string- Log file namelevel:string- Minimum log level to be logged
Dev Notes:
- Using the generated
.d.tsfiles obfuscate the code implementation. Whereas, using the.tswill direct you to go directly to the implementation code. - To make transpiling faster, set
ts-loaderto only transpile code, by using this optiontranspileOnly: true. And run the type checker using thefork-ts-checker-webpack-pluginplugin in the Webpack. The downside is that you have to emit declaration in a separate process like,tsc --emitDeclarationOnly --watch