petrol-tis v0.14.0

Petrol TIS - backend

Petrol TIS backend service.

Authors

• Miran Šetinc - Project maintainer
• Denis Božović - Project maintainer
• BE team - Developers

Setting up

Requirements

• Node.js v8.12.0
• MongoDB v3.6.0
• Smart Jobber
• Smart Stack
• Smart Ticker
• TIS Client
• TIS Processing

Quick start

Create a folder and make it your current working directory:

mkdir tis-be
cd tis-be

Clone project:

# clone with HTTPS
git clone https://git.smartis.si/Malovrh/petrol-tis.git .

# or clone with SSH
git clone git@git.smartis.si:Malovrh/petrol-tis.git .

Install dependencies:

npm install

Generate new .env configuration file and change it according to your needs:

# generate .env file with default values
npm run config-init

# add missing values or change it according to your needs
vi .env

See a list of available configuration-variables.

To make sure your modified .env file is correct, run:

npm run config-dump

optional Generate API documentation specification file, if you want to access API documentation:

npm run generate-openapi-specs

*if you skip this step and you want to expose documentation, you will get a warning

To start the app in dev mode run:

npm run dev

To start the app in production mode run:

npm start

Documentation

• Configuration
• Usage
• Integrations
• Development
• Deployment