/refarch-kc

Implementation solution for container shipment using Event Driven Architecture

Primary LanguageShellApache License 2.0Apache-2.0

K Container Shipment EDA reference implementation

The IBM Event Driven architecture reference implementation illustrates the deployment of real time analytics on event streams in the context of container shipment in an event driven architecture with event backbone, functions as service and microservices, and aims to illustrate the different event driven patterns like event sourcing, CQRS and Saga.

To read the detail of this implementation go to the book view

Building this booklet locally

The content of this repository is written with markdown files, packaged with MkDocs and can be built into a book-readable format by MkDocs build processes.

  1. Install MkDocs locally following the official documentation instructions.
  2. git clone https://github.com/ibm-cloud-architecture/refarch-kc.git (or your forked repository if you plan to edit)
  3. cd refarch-kc
  4. mkdocs serve
  5. Go to http://127.0.0.1:8000/ in your browser.

Pushing the book to GitHub Pages

  1. Ensure that all your local changes to the master branch have been committed and pushed to the remote repository.
    1. git push origin master
  2. Ensure that you have the latest commits to the gh-pages branch, so you can get others' updates.
    git checkout gh-pages
    git pull origin gh-pages
    
    git checkout master
  3. Run mkdocs gh-deploy from the root refarch-kc directory.

Contribute

As this implementation solution is part of the Event Driven architeture reference architecture, the contribution policies apply the same way here.

Contributors:

Please contact me for any questions.