Giter Club home page Giter Club logo

interactive-bpmn-stories's Introduction

Interactive BPMN Stories

Why BPMN Stories?

While BPMN and DMN are easy-to-learn modeling notations, using them to their fullest capacity, as with everything, takes practice.

This webapp provides a framework to create interactive stories that allow teaching either specific features of the modeling languages, or more intricate patterns and use cases.

These stories consist of a messenger-style conversation, and a canvas to display BPMN, DMN and Form files, including the BPMN token simulation to make learning even more easy.

The Interactive BPMN Stories in action

Example Stories

You can find some example stories in the Camunda Consulting Github.

Features

  • Create conversations between up to 4 participants + narration
  • Use questions and answers to lead the story along different threads
  • Display one or more BPMN, DMN and Form files alongside your story
  • Conclude your story with good and bad endings

Technical Details

The stories are configured and described via a TypeScript file. Each story contains two lists of threads: one for messages, one for files. Threads can be used to react to correct/false answers from the user.

Assets are stored in the /public/ folder and imported from there.

CamundaCon 2024 - Hackday

Technical Prerequisites

  • Git client
  • Github account
  • Node.js
  • IDE of your choice

Grab a Copy of the Code

  1. Fork the repository: Fork button
  2. Clone your forked copy: git clone [email protected]:<YOUR_NAME>/interactive-bpmn-stories.git.
  3. Navigate to the folder: cd interactive-bpmn-stories
  4. Open the project in your IDE (e.g., code . for Visual Studio Code).

Build & Run the Application

  1. Build the application: npm install

    This should produce an output similar to this: Output of successful "npm install"

  2. Run the application: npm run dev

    You should get the following output: Output of successful "npm run dev"

  3. Open http://localhost:5173/interactive-bpmn-stories in your browser.

Hack away!

Publish Your Story

git add <File>
git commit -m “some commit message”
git push

Create a Pull Request in the Official Repository

  1. Create a pull request: Pull request button
  2. Wait for your story to be merged into the official repository.

General Tips

  • Decide what the Story will be about
    • A BPMN/DMN/Form concept
    • A specific use case
    • An onboarding experience
  • Limit the scope (participants, threads)
  • Split up the work
  • Make use of live editing for frequent testing
  • Ask for help if necessary!

Story Display

The merged stories can be viewed on your notebook, tablet or phone:

QR code for the merged stories

⚠️ On mobile devices touch controls are currently not available.

interactive-bpmn-stories's People

Contributors

till-stadtler avatar hkupitz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.