README.md

A progressive Node.js framework for issue management in component-based architectures.

Description

Cross-Component Issue Management framework to improve cross-component issue management in component-based architectures, such as microservice architectures.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch development mode with hot code replacement
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Generating and navigating to the documentation page

# generate documentation
$ npx compodoc -p tsconfig.json -s

Open your browser and navigate to the documentation page.

Swagger API documentation

Run the app and go to /api endpoint for Swagger UI or /api-jsonto get the swagger description in JSON format.

Support

Cross-Component Issue Management is a research project to improve issue management in component-based architectures, such as microservice architectures. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please contact the author.

Stay in touch

• Author - Sandro Speth
• Website - TBA