service

Application that yada yada yada.

Installing

• This package is meant to be used as a docker container, passing the environment variables as defined below.

docker run -d giltayar/service

• Alternatively, it can be run using ./scripts/run-service.js, passing the environment variables as defined below.

npm install -g @giltayar/service
run-service.js

• Alternatively, you can import it and create the app (see below), passing it the configuration as defined below.

npm install @giltayar/service

Services it depends on

• Yada: yada yada

Queue Job Schema

A JSON with the following fields:

• yada: yada yada

Environment variables needed by docker container and application

• YADA_YADA: yada

Using the package to run the application

const createApp = require('@giltayar/service')

// configuration options aee the same as the above corresponding environment variables
const app = createApp({})

// app is an express app. Use listen to start it in the usual way
app.listen(/*...*/)