Skip to main content

Workbench Server

A REST server implementation support the routes from various packages.

A deployment of this API can be found here https://workbench-api.twindev.org/info

Building and running the application​

To install the dependencies, perform a full build and start the server.

npm install
npm run dist
npm start

Development mode​

Once you have performed a full build you can run the server in development mode, this will watch the TypeScript code, rebuild if there are any changes, and relaunch the server.

npm run dev

Configuration​

There are various options you can set through configuration, these can be found in docs/configuration.md

Deployment​

Examples of how to deploy the app can be found in docs/deployment.md

Changelog​

The changes between each version can be found in docs/changelog.md