mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 12:17:08 +00:00

Files

D. Berge 7bb3a3910b Show development activity log.

A button in the help dialogue takes the user to the
/feed/… frontend URL, where the latest development
activity is shown, taken from the GitLab RSS feed
for the project.

2021-05-08 00:46:31 +02:00

api

Show development activity log.

2021-05-08 00:46:31 +02:00

events

Run events manager in a separate process.

2020-10-02 01:34:49 +02:00

lib

Handle planner sequence value for first line in prospect.

2021-05-08 00:20:15 +02:00

spec

Document login and logout endpoints

2020-10-23 17:28:41 +02:00

udp

Remove logging statement

2020-09-13 17:30:25 +02:00

Listen for planner events

2020-10-09 13:55:34 +02:00

index.js

Run events manager in a separate process.

2020-10-02 01:34:49 +02:00

package-lock.json

Update package dependencies

2021-05-07 14:04:12 +02:00

package.json

Create HTML version of OpenAPI doc on install.

2020-12-29 16:18:53 +01:00

README.md

Add API documentation

2020-10-23 11:09:08 +02:00

README.md

Dougal web server

Backend server for the user interface

Install

Clone / copy this directory to the destination directory and then run

npm install

Run

In production this should be run as a system service, but for development or a one-off run:

node index.js

npm start

Options

The following environment variables affect the behaviour of the application:

NODE_ENV: If NODE_ENV=test some output messages are suppressed.
HTTP_PORT: Port to listen on. Default is 3000.
HTTP_PATH: Path to prepend to the API routes. Default is null.
DOUGAL_API_CONFIG: Location of the API configuration file. Default is $HOME/etc/www/config.json.

The server always listens on 127.0.0.1. Use a proxy like Nginx to expose it to the network.

Use

The API specification may be found under ./spec.

Generate the documentation with:

./node_modules/.bin/redoc-cli bundle ./spec/openapi.yaml