@daowolf/system-design-quest 0.0.0-stage → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oleg Desantis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,65 @@
-# Temporary Holding Version
+# System Design Quest
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Practise system design interviews as a game. Training chapters build the
+knowledge; quests are katas where you design one product end to end.
+
+**Try it:** [daowolf.com/system-design-quest](https://daowolf.com/system-design-quest)
+
+## What you get
+
+- **Training:** eight chapters, from the interview method to core concepts,
+  key technologies and patterns. They open in order, or jump into any of them.
+- **Quests:** design a URL shortener, a rate limiter, file storage and sync,
+  nearby places and ride booking. Every quest is open from the start.
+- **Eleven kinds of challenge:** trade-off duels, filling and labelling
+  diagrams, spotting the flaw, estimates, written answers, lightning rounds,
+  timed sprints and more.
+- **Points for right answers only.** A miss costs nothing and comes back later.
+- **An optional profile:** add who you're interviewing with and when, for a
+  countdown. Leave it empty and the game works the same.
+- No account, no adverts, and nothing you type leaves your browser.
+
+## Use it on your own page
+
+```html
+<script type="module" src="element.js"></script>
+<system-design-quest static></system-design-quest>
+```
+
+Keep `style.css` and `chapters.json` next to the script (and
+`element.js.map`, if you want source maps). Add `theme="dark"` or
+`theme="light"` to override the visitor's setting.
+
+Get the files one of two ways:
+
+- **npm:** `npm install @daowolf/system-design-quest`, then copy
+  `node_modules/@daowolf/system-design-quest/dist/` into your site at build
+  time. npm shows which commit and workflow built each version (provenance).
+- **A [release](https://github.com/dao-wolf/system-design-quest/releases):**
+  GitHub signs each one, so you can check where it came from.
+
+## Develop
+
+You need Node 22 or later, pnpm 10 and Python 3.10 or later.
+
+```sh
+pnpm install
+python3 -m pip install -r requirements.txt
+pnpm dev     # local page on port 4181
+pnpm check   # everything CI runs
+```
+
+## How it's tested
+
+- **Journeys:** Playwright plays the built game on a host page, under a strict
+  security policy, with axe checking accessibility.
+- **Logic:** unit tests on the scoring engine and the content gate.
+- **Content gate:** a script checks every challenge against its schema, length
+  limits and an allowlist of sources before it can ship.
+- **Mutation testing:** Stryker changes the scoring engine on purpose; the
+  tests must notice.
+- **Security:** lint rules, dependency checks and code scanning.
+
+## Licence
+
+Code: [MIT](LICENSE). Challenges: [CC BY 4.0](content/LICENSE.md).

package/content/LICENSE.md

@@ -0,0 +1,8 @@
+# Licence for the challenges
+
+The challenges in this folder are licensed under the
+[Creative Commons Attribution 4.0 International licence (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
+
+You may share and adapt them for any purpose, if you credit
+"System Design Quest by Oleg Desantis" and link to
+https://github.com/dao-wolf/system-design-quest.