0.0.1 • Published 3 years ago
ethereum-orchestrator v0.0.1
Orchestrate
This repository provides the following setup:
- Node.js express server
- TypeScript integration
- Linting using TSLint
- Docker support
bpmn-moddle
integration
It can be used as a basic REST API server. The repository also contains some basic examples on how to load and use BPMN models from XML files.
Repository Structure
assets/
| static filessrc/
| TypeScript source files.dockerignore
| files ignored by Docker when copying.gitignore
| files ignored by GitDockerfile
| Docker configurationREADME.md
nodemon.js
| nodemon configuration, used to rebuild and reload server on file changespackage*.json
| Node.js package configurationtsconfig.json
| TypeScript transpiler configurationtslint.json
| TSLint configuration (code style)
Routes
There are two sample routes:
/gateways
Returns all the gateways in thesample.bpmn
sample./neighbors/:id
Returns all the predecessors/successors of the element with the given ID from theorder.bpmn
example.
Usage
Running Locally
Make sure you have Node.js installed.
Installation
npm install
Scripts
npm run build
- builds the project, i.e., compiles the TypeScript code to JavaScriptnpm run serve
- serves the previously built projectnpm run watch
- build the projects, serves it and automatically updates on local changesnpm run lint
- runs the linter
Using Docker
docker build -t eth-orchestrate .
docker run --rm -p 3000:3000 --name eth-orchestrate -it eth-orchestrate
License
MIT
0.0.1
3 years ago