mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-22 19:31:33 +00:00
Code Issues Releases Wiki Activity

Review README with Zsuuuuuzsi

Browse Source
This commit is contained in:
Kristóf Tóth 2018-04-25 16:10:12 +02:00
parent c831ba5ca4
commit f4310c855f
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -3,11 +3,11 @@
This is the beating heart of TFW – the Docker baseimage containing the internals of the framework. This is the beating heart of TFW – the Docker baseimage containing the internals of the framework.
Every tutorial-framework based challenge has a `solvable` Docker image based on this one: their `Dockerfile`s begin with `FROM eu.gcr.io/avatao-challengestore/tutorial-framework`. Every tutorial-framework based challenge has a `solvable` Docker image based on this one: their `Dockerfile`s begin with `FROM eu.gcr.io/avatao-challengestore/tutorial-framework`.
Note that TFW is not avaliable on Docker Hub due to legal reasons and is only accessible through local builds (dont't worry, we've got you covered with build scripts in the `test-tutorial-framework` repo). Note that TFW is not avaliable on Docker Hub due to legal reasons and is only accessible through local builds (don't worry, we've got you covered with build scripts in the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repo).
This document explains the general concepts of TFW and should be the first thing you read before getting started with development. This document explains the general concepts of TFW and should be the first thing you read before getting started with development.
For more on building and running you should consult the `test-tutorial-framework` repo. For more on building and running you should check the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repo.
## The framework ## The framework
@ -22,9 +22,9 @@ Frontend components use websockets to connect to the TFW server, to which you ca
### Event handlers ### Event handlers
Imagine event handlers as callbacks that are invoked when TFW receives a specific type of message. For instance you could send a message to the framework when the user does something of note. Imagine event handlers as callbacks that are invoked when TFW receives a specific type of message. For instance, you could send a message to the framework when the user does something of note.
This allows you to define actions triggered on the backend when the user presses a button on the frontend, moves the cursor to a specific area or anything like that. Event handler allow you to define actions triggered on the backend when the user presses a button on the frontend or moves the cursor to a specific area, etc.
Event handlers use ZeroMQ to connect to the framework. Due to this they are as loosely-coupled as possible: usually they are running in separate processes and only communicate with TFW through ZMQ. Event handlers use ZeroMQ to connect to the framework. Due to this they are as loosely-coupled as possible: usually they are running in separate processes and only communicate with TFW through ZMQ.
@ -38,9 +38,9 @@ Inside Avatao this means that any of the content teams can use the framework wit
Another unique feature of the framework is the FSM – finite state machine – representing the state of your challenge. Another unique feature of the framework is the FSM – finite state machine – representing the state of your challenge.
This allows you to track users progressing with the tasks you've defined for them to complete. This allows you to track users progressing with the tasks you've defined for them to complete.
For instance you could represent whether the user managed to create a malicious user with a state called `user_registered` and subscribe callbacks to events regarding that state (like entering or leaving). For instance, you could represent whether the user managed to create a malicious user with a state called `user_registered` and subscribe callbacks to events regarding that state (like entering or leaving).
You could create challenges that can be completed in several different ways: imagine a state called `challenge_complete`, which represents when the challenge is completed. Several series of actions (triggers) could lead to this state. You could create challenges that can be completed in several different ways: imagine a state called `challenge_complete`, which indicates if the challenge is completed. Several series of actions (triggers) could lead to this state.
This enables you to guide your users through the experience you've envisioned with your tutorial. This enables you to guide your users through the experience you've envisioned with your tutorial.
We can provide a whole new level of interactivity in our challenges because we know what the user is doing. We can provide a whole new level of interactivity in our challenges because we know what the user is doing.
@ -48,12 +48,12 @@ This includes context-dependent hints and the automatic typing of commands to a
### Frontend ### Frontend
Note that our frontend implementation is written in Angular. It is maintained and documented in the `frontend-tutorial-framework` repository. Note that our frontend implementation is written in Angular. It is maintained and documented in the [frontend-tutorial-framework](https://github.com/avatao-content/frontend-tutorial-framework) repository.
### Messaging format ### Messaging format
The framework uses JSON messages internally and in exposed APIs as well. The framework uses JSON messages internally and in exposed APIs as well.
These messages must comply some rules. These messages must comply with some rules.
Don't worry, we are not too fond of rules around these parts. Don't worry, we are not too fond of rules around these parts.
The TFW message format: The TFW message format:
@ -80,4 +80,4 @@ The TFW message format:
Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info. Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info.
To get started you should take a look at the `test-tutorial-framework` repository, which serves as an example project as well. To get started you should take a look at the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository, which serves as an example project as well.