+
+
+
Real run, no mocks: the database accepts 5432 from anywhere → Validate → ✗ with the reason → the firewall is tightened to the two app servers → Validate → ✓ → roadmap complete.
+ +Website: [torollo.app](https://torollo.app) · Package: [npm](https://www.npmjs.com/package/torollo) · License: MIT --- @@ -25,7 +29,7 @@ Docker must be running. Then, without cloning or installing anything permanently npx torollo start ``` -Open the app, create a project, and hit **Learning** in the topbar — the best first contact with Torollo is a guided roadmap, not an empty canvas. Start with **Deploy a resilient three-tier app**: it walks you from a single web server to a load-balanced, firewalled, database-backed architecture in ten validated steps. +Open the app and pick **Start learning** on the first-run screen (the **Learning** tab in the left rail brings the catalogue back at any time). The best first contact with Torollo is a guided roadmap, not an empty canvas. Start with **Deploy a resilient three-tier app**: it walks you from a single web server to a load-balanced, firewalled, database-backed architecture in ten validated steps. ### Run with Docker Compose @@ -77,7 +81,7 @@ Project and roadmap-progress data live in the `torollo-data` named volume. `dock ## Guided, auto-graded roadmaps -The learning engine is what Torollo is really about. A roadmap is a sequence of steps — instructions, progressive hints, a solution if you're stuck — and every step is closed by **validators that assert against the real state of your lab**: +The learning engine is what Torollo is really about. A roadmap is a sequence of steps (instructions, progressive hints, a solution if you're stuck), and every step is closed by **validators that assert against the real state of your lab**: * container status and ASG replica counts, * SQL schemas and data, MongoDB collections, Redis keys, @@ -91,7 +95,7 @@ Current catalogue (English and French): | Roadmap | Difficulty | ~Time | You practice | |---|---|---|---| | Deploy a resilient three-tier app | intermediate | 40 min | Load balancing, security groups, private subnets, autoscaling | -| Cache-aside with Redis | intermediate | 30 min | Caching strategy, TTLs, invalidation, measuring hit rates | +| Cache-aside with Redis | intermediate | 45 min | Caching strategy, TTLs, invalidation, measuring hit rates, surviving a cache outage | | Workers & the Redis job queue | intermediate | 40 min | Async decoupling, queues, scaling workers under load, poison messages | **Roadmaps are plain JSON — no code.** The format is open and documented in the [Roadmap Authoring Reference](docs/roadmap-format.md); drop a valid file into `roadmaps/` — or import any roadmap file or `.zip` pack from the Learning page, no repo checkout needed ([how it works](docs/local-roadmaps.md)) — and it appears in the catalogue. Community-authored roadmaps are very welcome. The validation HTTP API is documented in [learning-api.md](docs/learning-api.md). @@ -184,7 +188,7 @@ Forks and self-hosters can point events at their own [Plausible](https://plausib * **Write a roadmap** — the highest-leverage contribution, and it's JSON only. Start from the [format reference](docs/roadmap-format.md). * **Add a node type** — follow the step-by-step [adding-a-node guide](docs/adding-a-node.md). -* **Everything else** — see [CONTRIBUTING.md](CONTRIBUTING.md). Ideas for new directions (observability nodes, exporting a topology to IaC, …) are best opened as an issue first. +* **Everything else** — see [CONTRIBUTING.md](CONTRIBUTING.md). Ideas for new node types or new directions are best opened as an issue first, before any code. --- diff --git a/SECURITY.md b/SECURITY.md index b8e5f9c..5f97397 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,12 +2,7 @@ ## Supported Versions -Only the latest `main` branch and the most recent release receive security updates. - -| Version | Supported | -| ------- | ------------------ | -| 1.0.x | :white_check_mark: | -| < 1.0 | :x: | +Only the latest published npm release and the `main` branch receive security updates. Older releases are not patched; upgrade with `npx torollo@latest start`. ## Network Exposure Defaults diff --git a/package.json b/package.json index 6704402..6951983 100644 --- a/package.json +++ b/package.json @@ -1,17 +1,21 @@ { "name": "torollo", "version": "1.2.4", - "description": "Interactive visual system design learning lab and container supervisor.", + "description": "Local-first system design lab: every node on the canvas is a real Docker container, and guided roadmaps grade each step against the live state of your system.", "keywords": [ "system-design", "docker", + "backend", "architecture", + "networking", + "roadmaps", + "learning", + "lab", "simulator", - "backend", "education", - "microservices", - "visualizer" + "devops" ], + "homepage": "https://torollo.app", "author": "Youssef", "license": "MIT", "repository": {