``
O .
O ' '
o ' .
o .'
__________.-' '...___
.-' ### '''...__
/ a### ## ''--.._ ______
'. # ######## ' .-'
'-._ ..#### ___...---'''\ '
'-._ __________...---''' \ l
\ | '._|
\__;
`

Orka

A modern Node.js framework based on koa@2 that comes powered with RabbitMQ, Kafka, MongoDB and Redis integrations out of the box.

Installation

npm install @workablehr/orka

Usage

Orka uses some defaults for the below values in your config.js

`js
config = {
nodeEnv :'development';
app: {
name: 'orka', // will be used as newrelic name, rabbit-queue prefix
env: 'demo' // will be used as newrelic, honeybadger env - defaults to NODE_ENV
},
mongodb: {
url: '',
options: {}
},
redis: {
url:'',
options: {
tls: { // If those fields are empty they will not be passed in
ca: [], // Redis driver. This way you can have the same app working
cert: '',// with a redis that support tls and a redis that doesn't with
key: '' // environment variable changes only.
}
}
}
honeybadger:{
apiKey: '', // will not add honeybadger by default
}
newRelicLicenseKey: '', // will not add newrelic by default
log : {
pattern: '%[[%d] [%p] %c%] %m',
level: 'debug',
},
port: 3000,
cors: {
allowedOrigins: ['localhost', 'lvh.me'],
credentials: true, // Adds cors needed for exchanging cookies over https.
publicPrefixes: ['/publicEndpoints/foo/bar'] // ctx.path prefixes that will return access-control-allow-origin: *
…
},
traceHeaderName: 'X-Orka-Request-Id', // for logging in http requests
visitor: { orka: true, cookie : 'wmc' }, // for adding visitor id in ctx.state
headersRegex: '^X-.*', // for logging headers in http requests
blacklistedErrorCodes: [404] // will not send to honeybadger requests with this status
}
`

`js
const { orka } = require('@workablehr/orka');

// these options are the defaults
orka({
appName: '', // defaults to config.app.name
typescript: false,
honeyBadger: {
developmentEnvironments: ['development', 'test']
},
routesPath: path.resolve('./config/routes'),
diamorphosis: {
configFolder: path.resolve('config'),
configPath: path.resolve('config/config.js'),
envFolder: path.resolve('config/env')
loadDotEnv: ['development']
},
beforeMiddleware: async (app, config) => [], // return array of Middlewares or one Middleware
afterMiddleware: async (app, config) => [], // return array of Middlewares or one Middleware
beforeStart: [] // functions to run before start
}).start();

// this way you can update some configuration with envs only.
`

Using the builder you can access a fluent API for initiliazing your server.

`js
const { builder } = require('@workablehr/orka');

builder({…some static options here…})
.forTypeScript()
.withRabbitMQ('my-app-name')
.withHoneyBadger({…})
.withMongoDB()
.withRedis()
.use((app, config) => async (ctx, next) => {…before middleware…})
.useDefaults() // riviere, cors, etc.
.use((app, config) => async (ctx, next) => {…after middleware…})
.routes('./routes/my-routes')
.start(8080)
``

For detailed usage please see the documentation.