Event Modeling Language (EML)

Getting Started

Prerequisites

• NodeJS 8.11.1 LTS or better
• docker-compose

Installation

Latest version from source:

git clone https://github.com/robertreppel/les.git
make install

... or ...

Instructions for Linux, Windows Mac & Docker

Hello World

Step 1:

Create an Event Storming Language file. Event Storming Language (ESL) is a simple language used to describe an event storming:

/// TODO List
Add Item -> : description, dueDate
Todo Added : description, dueDate
TODO List* : todoId, description, dueDate

Save it to Eventstorming.esl.

Step 2:

les convert && les-node -b && cd api && npm install && docker-compose up -d --force-recreate

Or using Docker:

docker run -v $(pwd):/les les convert && docker run -v $(pwd):/les les-node -b && cd api && npm install && docker-compose up -d

(If you doing this in Linux and encounter "permission denied" errors, your USER or GROUP ID need to be specified. Say your USER ID is 1003, then add --user 1003 after each docker run in the above command.)

Step 3:

Try it:

• Add some items to the TODO list: http://localhost:3001/api-docs (Swagger/OpenAPI)
• View the items: http://localhost:3001/api/v1/r/TODOList
• Look at the "TodoAdded" events in the Eventstore DB: http://localhost:2113 (username 'admin', password 'changeit')
• Check out the source code for the "TODO List" system: ./api
• For more ESL examples, check out the "samples" folder.

Running The Tests

make test

make test-esl-compliance

make test-eml-compliance

Roadmap

Features & Fixes