Skip to content

Microservice to aggregate the compatibility matrix for Iroha 2 Documentation.

Notifications You must be signed in to change notification settings

soramitsu/iroha2-docs-compat-matrix-service

Repository files navigation

Compatibility Matrix collector

For the documentation site of Iroha 2.

Prepare

Install Deno.

Run

Run:

deno run src/main.ts

With all allowances:

deno run --allow-read --allow-env --allow-net src/main.ts

Use

Use the following request to get the parsed compatibility matrix (port depends on the configuration):

GET http://localhost:8080/compat-matrix

Configuration

Either in ENV or in .env:

  • ALLURE_BASE_URL: base URL for Allure API calls
  • ALLURE_API_TOKEN: API token to make Allure API calls
  • PORT (optional, default: 8080): server port
  • LOG_LEVEL (optional, default: INFO): no comments

See also: .env.example

Docker deployment

The project has Dockerfile. Default exposed port is 4000.

Update deno.lock

If needed remove deno.lock first

deno cache --lock=deno.lock deps.ts

Prototyping

There is allure_compat_matrix.livemd - a Livebook notebook used for prototyping of the data flow. It can be used as a reference and as a tool for further updates. Please refer to the Livebook documentation on how to use it if you want.

About

Microservice to aggregate the compatibility matrix for Iroha 2 Documentation.

Resources

Stars

Watchers

Forks

Packages

No packages published