ianus

Boilerplate for creating npm packages.

Table of Contents

• Requirements
• Installation
• Usage
• Contribute

Requirements

To use library you need to have node and npm installed in your machine:

• node >=10
• npm >=6

Package is continuously tested on darwin, linux and win32 platforms. All active and maintenance LTS node releases are supported.

Installation

Use next docker images:

  docker pull pustovitdmytro/ianus-worker
  docker pull pustovitdmytro/ianus-admin

Usage

Run admin panel

  docker run -p 3000:8010 --env-file .env pustovitdmytro/ianus-admin:latest

Open localhost:3000

Run worker

  docker run --env-file .env pustovitdmytro/ianus-worker:latest

Jobs can be managed via bull dashboard:

to access dashboard, visits

  /admin/bull

to retrieve project information, check

  /admin/info

healthcheck:

  /health

Administration credentials

User: admin

Password: configured via BASIC_ADMIN_PASSWORD variable, 'password' by default.

Note! It is recomended to change default BASIC_ADMIN_PASSWORD.

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.