Table of Contents
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
baseimage-tutorial-framework
This is the beating heart of TFW – the Docker baseimage containing the internals of the framework. It's most important element is the robust messaging system based on ZeroMQ, that makes it straightforward to implement interactive exercises.
frontend-tutorial-framework
This is the Angular frontend of TFW.
Mostly it's just a thin displays layer and complex logic should be implemented in the container instead.
Apart from configuring it, you shouldn't have to mess with it directly, as our built-in event handlers (maintained in the baseimage repository) will do the heavy lifting for you (i.e. instrumenting the frontend with the proper messages and whatnot).
The main exposed features are our pre-implemented components based on the src/app/services/websocket.service.ts service.
This service implements a communication API based on RxJS and WebSockets to communicate with the framework backend (TFW server and event handlers). More useful features include a bunch of pre-designed layouts and dynamic switching between them.
test-tutorial-framework
This is an example playground project built via TFW. It is a good starting point to build your own challenges from. It also gives home to several useful scripts in the hack folder to speed up development. If you are unfamiliar with the Avatao challenge structure, inspect the challenge-toolbox first.