FlowSpace Docs
[ 01 ] OVERVIEW PREHĽAD

FlowSpace. FlowSpace.

An open, full-stack educational simulation platform for teaching and exploring system thinking — built with FastAPI, PostgreSQL and React. Otvorená full-stack vzdelávacia simulačná platforma pre výučbu a skúmanie systémového myslenia — postavená na FastAPI, PostgreSQL a Reacte.

[ 1.1 ]What is this projectO čom je tento projekt

FlowSpace is a teaching tool that turns abstract system dynamics concepts into interactive visual simulations. Students work with generic system structures (archetypes), run simulations, progress through lessons and tasks, and see feedback loops in action. FlowSpace je učebný nástroj, ktorý pretvára abstraktné koncepty systémovej dynamiky do interaktívnych vizuálnych simulácií. Študenti pracujú so všeobecnými systémovými štruktúrami (archetypy), spúšťajú simulácie, postupujú cez lekcie a úlohy, a vidia spätnoväzbové slučky v akcii.

The project is born as a Bachelor thesis at Comenius University in Bratislava, and designed to be forkable, self-hostable and easy to extend. Projekt vznikol ako bakalárska práca na Univerzite Komenského v Bratislave a je navrhnutý tak, aby sa dal forkovať, self-hostovať a ľahko rozširovať.

[ 1.2 ]Key featuresKľúčové funkcie

[ F01 ]

Visual System EditorVizuálny editor systémov

Drag-and-drop canvas (React Flow) to wire stocks, flows and feedback loops without writing code. Drag-and-drop plátno (React Flow) na prepájanie zásob, tokov a spätných väzieb bez kódu.

[ F02 ]

Live Simulation RunsŽivé simulačné behy

Deterministic backend simulations with replayable runs, charts and history stored per user. Deterministické simulácie na backende s prehrávateľnými behmi, grafmi a históriou uloženou pre každého používateľa.

[ F03 ]

Lessons & TasksLekcie a úlohy

Structured learning path with guided tasks, automatic progress tracking and seeded content out of the box. Štrukturovaná cesta učenia s vedenými úlohami, automatickým sledovaním pokroku a prednastaveným obsahom.

[ F04 ]

Auth & OAuthAutentifikácia a OAuth

JWT email/password login plus optional Google and GitHub providers — buttons auto-appear when keys are set. JWT prihlásenie emailom/heslom plus voliteľné Google a GitHub OAuth — tlačidlá sa zjavia automaticky podľa nastavených kľúčov.

[ F05 ]

Docker-firstDocker-first

One command brings up the API, database and frontend — consistent across macOS, Linux and Windows. Jeden príkaz spustí API, databázu a frontend — konzistentne na macOS, Linuxe aj Windows.

[ F06 ]

Open & ForkableOpen a forkovateľné

Clean three-layer architecture, documented env vars and Alembic migrations — fork it, remix it, use it in your own course. Čistá trojvrstvová architektúra, dokumentované env premenné a Alembic migrácie — forkni, remixuj, použi vo vlastnom kurze.

[ 1.3 ]Why use FlowSpacePrečo FlowSpace

  • Pedagogy-driven. Designed around real teaching scenarios for system thinking, not a generic diagram tool.Pedagogicky orientované. Navrhnuté okolo reálnych vyučovacích scenárov pre systémové myslenie, nie všeobecný diagramový nástroj.
  • Zero-to-running in minutes. One Docker command or a short local guide.Od nuly k behu za minúty. Jeden Docker príkaz alebo krátky lokálny návod.
  • Modern stack. FastAPI, SQLAlchemy 2, Alembic, React 18, Vite 5, TypeScript.Moderný stack. FastAPI, SQLAlchemy 2, Alembic, React 18, Vite 5, TypeScript.
  • Bilingual UI-ready. The docs, site and app are built with EN/SK switching in mind.Dvojjazyčné UI. Dokumentácia, stránka aj aplikácia sú stavané s prepínaním EN/SK.
  • Transparent data. PostgreSQL with migrations — no hidden proprietary storage.Transparentné dáta. PostgreSQL s migráciami — žiadne skryté proprietárne úložiská.

[ 1.4 ]Tech stackTechnologický stack

LayerVrstva TechnologiesTechnológie
FrontendFrontendReact 18, TypeScript, Vite 5, React Flow
BackendBackendPython 3.13, FastAPI, SQLAlchemy 2, Alembic
DatabaseDatabázaPostgreSQL 17
RuntimeRuntimeDocker Engine 24+, Docker Compose v2

[ 1.5 ]Where to nextKam ďalej

If you are setting up the project for the first time, follow the pages below in order. Ak projekt spúšťaš prvýkrát, prejdi si stránky nižšie v poradí.

  • Local Install — run the project on your machine from scratch.Lokálna inštalácia — spusti projekt na svojom stroji od nuly.
  • Docker — run it in containers on laptop or server.Docker — spusti v kontajneroch na notebooku alebo serveri.
  • From GitHub — clone, configure and deploy from source.Z GitHubu — naklonuj, konfiguruj a nasaď zo zdroja.
  • Contributing — fork rules and how to ship changes.Prispievanie — pravidlá forku a ako posielať zmeny.