Vibecode Craft
track this build5 phases, 15 steps, beginner friendly0%KINDA · weekend project
price $10/moyou'd save $120/yrbuild time one sittingcategory 🧠 notes & knowledgereplaced by 0 people
The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Craft, write visually polished documents, link them, and export a portable personal library. The hard boundary is native apps, sync, publishing, collaboration, and strong block-editor polish, plus sync, collaboration, and capture polish.
the project pack5 files · written for this build, step by step
You are building a lean indie version of Craft. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== README.md ===== # Craft · indie build Build a local document library with portable Markdown and safe backlinks. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | Markdown vault with rebuildable SQLite index | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | markdown, bleach | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Craft acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory If one of those is essential to you, that is the reason to keep paying for Craft, and the README should say so rather than pretend. ===== BRIEF.md ===== # Build brief · Craft The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a local document library with portable Markdown and safe backlinks as a bounded replacement for Craft. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: Markdown vault with rebuildable SQLite index. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: markdown, bleach. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - notes(id,title,path,content_hash) - links(source_id,target_id) - tags(note_id,tag) - revisions(id,note_id,hash,snapshot_path) - Markdown files in a user-selected vault are canonical - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: Two Markdown notes linked by stable note ids, an image and an externally edited file. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Craft acceptance sample: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start file-backed writing until these checks pass. ### Phase 2 · File-backed writing Build: File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: SQLite is a rebuildable index; it must not become a second competing source of document truth. Done when: Editing a file outside the app triggers a conflict instead of overwriting it. A note named ../../outside cannot write outside the vault. Do not build yet: Do not start links and navigation until these checks pass. ### Phase 3 · Links and navigation Build: Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Filenames alone are brittle identities for linked documents. Done when: Renaming a linked note preserves its incoming link and backlink. Searching a unique phrase finds the right note after an index rebuild. Do not build yet: Do not start portable presentation until these checks pass. ### Phase 4 · Portable presentation Build: Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Export the entire vault with an id/path manifest and implement import preview plus index rebuild. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. Done when: Export and reimport preserve both notes, the image and links. An embedded script in Markdown cannot execute in preview or print. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Craft replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish: retain the paid product if this capability is essential; it is outside this bounded build. - frictionless mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - real-time team editing: retain the paid product if this capability is essential; it is outside this bounded build. - hosted publishing: retain the paid product if this capability is essential; it is outside this bounded build. - proprietary AI memory: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://python-markdown.github.io/reference/ ; https://bleach.readthedocs.io/en/latest/clean.html. Recheck before upgrading; freeze the versions actually tested. ===== AGENTS.md ===== # Agent instructions · Craft indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, Markdown vault with rebuildable SQLite index, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, markdown, bleach. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - SQLite is a rebuildable index; it must not become a second competing source of document truth. - Filenames alone are brittle identities for linked documents. - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - Export without an import or restore rehearsal is not verified portability. ===== BUILD_PLAN.md ===== # Build plan · Craft Build a local document library with portable Markdown and safe backlinks. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · File-backed writing File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. ### Steps 1. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Files: `features/file_backed_writing.py`, `templates/file_backed_writing.html` 2. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Files: `features/file_backed_writing.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_file_backed_writing.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] A note named ../../outside cannot write outside the vault. ### Watch out - SQLite is a rebuildable index; it must not become a second competing source of document truth. ## Phase 3 · Links and navigation Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. ### Steps 1. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Files: `features/links_and_navigation.py`, `templates/links_and_navigation.html` 2. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Files: `features/links_and_navigation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_links_and_navigation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Searching a unique phrase finds the right note after an index rebuild. ### Watch out - Filenames alone are brittle identities for linked documents. ## Phase 4 · Portable presentation Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. ### Steps 1. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Files: `features/portable_presentation.py`, `templates/portable_presentation.html` 2. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Files: `features/portable_presentation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_presentation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Export and reimport preserve both notes, the image and links. - [ ] An embedded script in Markdown cannot execute in preview or print. ### Watch out - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. ## Phase 5 · Portable delivery and clean-start proof Finish the Craft replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory ## After v1, if you want it - Extend portable presentation only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/craft # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
You are building a lean indie version of Craft. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== README.md ===== # Craft · indie build Build a local document library with portable Markdown and safe backlinks. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | Markdown vault with rebuildable SQLite index | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | markdown, bleach | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Craft acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory If one of those is essential to you, that is the reason to keep paying for Craft, and the README should say so rather than pretend. ===== BRIEF.md ===== # Build brief · Craft The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a local document library with portable Markdown and safe backlinks as a bounded replacement for Craft. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: Markdown vault with rebuildable SQLite index. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: markdown, bleach. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - notes(id,title,path,content_hash) - links(source_id,target_id) - tags(note_id,tag) - revisions(id,note_id,hash,snapshot_path) - Markdown files in a user-selected vault are canonical - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: Two Markdown notes linked by stable note ids, an image and an externally edited file. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Craft acceptance sample: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start file-backed writing until these checks pass. ### Phase 2 · File-backed writing Build: File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: SQLite is a rebuildable index; it must not become a second competing source of document truth. Done when: Editing a file outside the app triggers a conflict instead of overwriting it. A note named ../../outside cannot write outside the vault. Do not build yet: Do not start links and navigation until these checks pass. ### Phase 3 · Links and navigation Build: Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Filenames alone are brittle identities for linked documents. Done when: Renaming a linked note preserves its incoming link and backlink. Searching a unique phrase finds the right note after an index rebuild. Do not build yet: Do not start portable presentation until these checks pass. ### Phase 4 · Portable presentation Build: Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Export the entire vault with an id/path manifest and implement import preview plus index rebuild. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. Done when: Export and reimport preserve both notes, the image and links. An embedded script in Markdown cannot execute in preview or print. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Craft replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish: retain the paid product if this capability is essential; it is outside this bounded build. - frictionless mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - real-time team editing: retain the paid product if this capability is essential; it is outside this bounded build. - hosted publishing: retain the paid product if this capability is essential; it is outside this bounded build. - proprietary AI memory: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://python-markdown.github.io/reference/ ; https://bleach.readthedocs.io/en/latest/clean.html. Recheck before upgrading; freeze the versions actually tested. ===== AGENTS.md ===== # Agent instructions · Craft indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, Markdown vault with rebuildable SQLite index, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, markdown, bleach. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - SQLite is a rebuildable index; it must not become a second competing source of document truth. - Filenames alone are brittle identities for linked documents. - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - Export without an import or restore rehearsal is not verified portability. ===== BUILD_PLAN.md ===== # Build plan · Craft Build a local document library with portable Markdown and safe backlinks. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · File-backed writing File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. ### Steps 1. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Files: `features/file_backed_writing.py`, `templates/file_backed_writing.html` 2. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Files: `features/file_backed_writing.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_file_backed_writing.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] A note named ../../outside cannot write outside the vault. ### Watch out - SQLite is a rebuildable index; it must not become a second competing source of document truth. ## Phase 3 · Links and navigation Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. ### Steps 1. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Files: `features/links_and_navigation.py`, `templates/links_and_navigation.html` 2. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Files: `features/links_and_navigation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_links_and_navigation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Searching a unique phrase finds the right note after an index rebuild. ### Watch out - Filenames alone are brittle identities for linked documents. ## Phase 4 · Portable presentation Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. ### Steps 1. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Files: `features/portable_presentation.py`, `templates/portable_presentation.html` 2. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Files: `features/portable_presentation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_presentation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Export and reimport preserve both notes, the image and links. - [ ] An embedded script in Markdown cannot execute in preview or print. ### Watch out - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. ## Phase 5 · Portable delivery and clean-start proof Finish the Craft replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory ## After v1, if you want it - Extend portable presentation only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/craft # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
You are building a production product version of Craft. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== PRODUCT.md ===== # Craft · product brief ## Problem The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Craft, write visually polished documents, link them, and export a portable personal library. The hard boundary is native apps, sync, publishing, collaboration, and strong block-editor polish, plus sync, collaboration, and capture polish. ## Product outcome An operated version of a local document library with portable Markdown and safe backlinks, with authorized access, restore evidence and honest scope limits. ## Target user A builder who needs a maintainable product foundation, not a one-off demo. ## Required capabilities - macOS, Windows, or Linux - local folder access - optional sync folder chosen by the user ## Explicit non-goals for v1 - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory ## Success criteria - Editing a file outside the app triggers a conflict instead of overwriting it. - Renaming a linked note preserves its incoming link and backlink. - Export and reimport preserve both notes, the image and links. - A private-data authorization check passes using a second identity. - An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - README names the excluded vendor capabilities and actual provider/hosting costs. ===== BRIEF.md ===== # Build brief · Craft The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a local document library with portable Markdown and safe backlinks as a bounded replacement for Craft. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: Markdown vault with rebuildable SQLite index. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: markdown, bleach. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - notes(id,title,path,content_hash) - links(source_id,target_id) - tags(note_id,tag) - revisions(id,note_id,hash,snapshot_path) - Markdown files in a user-selected vault are canonical - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: Two Markdown notes linked by stable note ids, an image and an externally edited file. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Craft acceptance sample: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start file-backed writing until these checks pass. ### Phase 2 · File-backed writing Build: File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: SQLite is a rebuildable index; it must not become a second competing source of document truth. Done when: Editing a file outside the app triggers a conflict instead of overwriting it. A note named ../../outside cannot write outside the vault. Do not build yet: Do not start links and navigation until these checks pass. ### Phase 3 · Links and navigation Build: Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Filenames alone are brittle identities for linked documents. Done when: Renaming a linked note preserves its incoming link and backlink. Searching a unique phrase finds the right note after an index rebuild. Do not build yet: Do not start portable presentation until these checks pass. ### Phase 4 · Portable presentation Build: Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Export the entire vault with an id/path manifest and implement import preview plus index rebuild. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. Done when: Export and reimport preserve both notes, the image and links. An embedded script in Markdown cannot execute in preview or print. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Craft replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish: retain the paid product if this capability is essential; it is outside this bounded build. - frictionless mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - real-time team editing: retain the paid product if this capability is essential; it is outside this bounded build. - hosted publishing: retain the paid product if this capability is essential; it is outside this bounded build. - proprietary AI memory: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://python-markdown.github.io/reference/ ; https://bleach.readthedocs.io/en/latest/clean.html. Recheck before upgrading; freeze the versions actually tested. ===== ARCHITECTURE.md ===== # Architecture · Craft ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | Markdown vault with rebuildable SQLite index | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | markdown, bleach | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Modules Each module has one owner concern and a documented way to replace it. | Module | Owns | How to replace it | | --- | --- | --- | | Data and identity | notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical | Keep stable ids and a versioned repository interface; migrate storage behind it with a fixture round-trip. | | File-backed writing | Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. | Keep the acceptance contract: Editing a file outside the app triggers a conflict instead of overwriting it. Replace only this module after replaying its fixture; preserve ids and existing records. | | Links and navigation | Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. | Keep the acceptance contract: Renaming a linked note preserves its incoming link and backlink. Replace only this module after replaying its fixture; preserve ids and existing records. | | Portable presentation | Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. | Keep the acceptance contract: Export and reimport preserve both notes, the image and links. Replace only this module after replaying its fixture; preserve ids and existing records. | | Operations | Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. | Change host or backup destination only after an isolated restore and authorization check. | ## Configuration Every runtime setting is an environment variable documented in `.env.example`, validated at startup, with a safe local default wherever one exists. - `DATA_DIR` · required · A new private folder this application creates on first run; never serve it as static files. - `SECRET_KEY` · required, secret · Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. - `APP_MODE` · required · Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. - `SITE_URL` · required · The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. ## Production baseline - Security: least privilege, input validation at every boundary, secret redaction in logs, rate limits on abuse-prone paths, no invented security primitives. - Data: explicit schema and migrations, transactional writes where integrity matters, backup and restore procedures that have been exercised. - Integrations: adapters around third-party providers, idempotent webhook or job processing, bounded retries, timeouts. - Observability: structured logs with request or operation ids, an error-tracking hook, and health and readiness checks where a server exists. - Quality: unit tests for domain rules, integration tests at module boundaries, one end-to-end test of the critical path. ## Decision records For each dependency in the stack table, keep a short note: why it was chosen, its failure mode, and how it is replaced. Do not add infrastructure until a requirement in `PRODUCT.md` justifies it. ===== AGENTS.md ===== # Agent instructions · Craft product build - Read `PRODUCT.md` and `ARCHITECTURE.md` before changing code. The stack is fixed: Python 3.12+ and Flask, Markdown vault with rebuildable SQLite index, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, markdown, bleach. - Implement milestone by milestone from `MILESTONES.md`; keep each change reviewable and leave the application runnable at every commit. - Treat authentication, payments, encryption, imports, webhooks and destructive actions as high-risk boundaries when present. - Never invent cryptography or silently weaken a requirement to make a check pass. - Put every external service behind an interface with a deterministic fake for tests. - Add migrations and rollback or recovery notes for every persistent data change. - Log useful operational context without credentials, tokens, passwords or personal data. - Update documentation and run every check before completing a milestone. ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - SQLite is a rebuildable index; it must not become a second competing source of document truth. - Filenames alone are brittle identities for linked documents. - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - Export without an import or restore rehearsal is not verified portability. - Product mode is additional engineering, not a switch that makes a local prototype production-ready. ===== MILESTONES.md ===== # Delivery milestones · Craft Estimated effort: **multi-day** for the indie phases; the production-only milestones add the trust and operability layer. ## M1 · Local foundation and data contract Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## M2 · File-backed writing File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. ### Steps 1. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Files: `features/file_backed_writing.py`, `templates/file_backed_writing.html` 2. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Files: `features/file_backed_writing.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_file_backed_writing.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] A note named ../../outside cannot write outside the vault. ### Watch out - SQLite is a rebuildable index; it must not become a second competing source of document truth. ## M3 · Links and navigation Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. ### Steps 1. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Files: `features/links_and_navigation.py`, `templates/links_and_navigation.html` 2. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Files: `features/links_and_navigation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_links_and_navigation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Searching a unique phrase finds the right note after an index rebuild. ### Watch out - Filenames alone are brittle identities for linked documents. ## M4 · Portable presentation Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. ### Steps 1. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Files: `features/portable_presentation.py`, `templates/portable_presentation.html` 2. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Files: `features/portable_presentation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_presentation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Export and reimport preserve both notes, the image and links. - [ ] An embedded script in Markdown cannot execute in preview or print. ### Watch out - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. ## M5 · Portable delivery and clean-start proof Finish the Craft replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## M6 · Operate and share with access controls (production only) Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. ### Steps 1. Establish owner access before exposure Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. Files: `ARCHITECTURE.md`, `OPERATIONS.md` 2. Deploy a monitored service Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Files: `Caddyfile`, `OPERATIONS.md` ```sh waitress-serve --listen=127.0.0.1:5000 app:app ``` 3. Rehearse loss and recovery Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. Files: `OPERATIONS.md`, `release-checklist.md` ### Done when - [ ] An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. - [ ] A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. - [ ] Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. ### Watch out - Product mode is additional engineering, not a switch that makes a local prototype production-ready. ===== OPERATIONS.md ===== # Operations · Craft ## Backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. ## Restore Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Do a restore drill before the first real user, and write the date here when it passes. ## Monitoring Check HTTP availability, free disk, backup age and domain failures for File-backed writing, Links and navigation, Portable presentation. Alert without logging private payloads. ## Incident checklist Pause outbound jobs and public intake as appropriate, preserve redacted diagnostics, restore an isolated verified backup, rotate affected credentials and reconcile uncertain effects before reopening. 1. Contain the issue without destroying evidence or user data. 2. Record the timeline and affected scope. 3. Rotate exposed secrets and revoke compromised sessions or credentials. 4. Restore from a verified backup when needed. 5. Document the root cause, the remediation and the regression test. ## Release gate - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Export and reimport preserve both notes, the image and links. - [ ] A private-data authorization check passes using a second identity. - [ ] An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - [ ] README names the excluded vendor capabilities and actual provider/hosting costs. ## Launch constraint Do not market omitted Craft capabilities as implemented. The non-goals in `PRODUCT.md` remain user-visible limitations until they are deliberately delivered. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/craft # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
README.md
# Craft · indie build Build a local document library with portable Markdown and safe backlinks. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | Markdown vault with rebuildable SQLite index | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | markdown, bleach | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Craft acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory If one of those is essential to you, that is the reason to keep paying for Craft, and the README should say so rather than pretend.
BRIEF.md
# Build brief · Craft The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a local document library with portable Markdown and safe backlinks as a bounded replacement for Craft. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: Markdown vault with rebuildable SQLite index. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: markdown, bleach. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - notes(id,title,path,content_hash) - links(source_id,target_id) - tags(note_id,tag) - revisions(id,note_id,hash,snapshot_path) - Markdown files in a user-selected vault are canonical - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: Two Markdown notes linked by stable note ids, an image and an externally edited file. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Craft acceptance sample: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start file-backed writing until these checks pass. ### Phase 2 · File-backed writing Build: File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: SQLite is a rebuildable index; it must not become a second competing source of document truth. Done when: Editing a file outside the app triggers a conflict instead of overwriting it. A note named ../../outside cannot write outside the vault. Do not build yet: Do not start links and navigation until these checks pass. ### Phase 3 · Links and navigation Build: Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Filenames alone are brittle identities for linked documents. Done when: Renaming a linked note preserves its incoming link and backlink. Searching a unique phrase finds the right note after an index rebuild. Do not build yet: Do not start portable presentation until these checks pass. ### Phase 4 · Portable presentation Build: Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Export the entire vault with an id/path manifest and implement import preview plus index rebuild. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. Done when: Export and reimport preserve both notes, the image and links. An embedded script in Markdown cannot execute in preview or print. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Craft replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish: retain the paid product if this capability is essential; it is outside this bounded build. - frictionless mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - real-time team editing: retain the paid product if this capability is essential; it is outside this bounded build. - hosted publishing: retain the paid product if this capability is essential; it is outside this bounded build. - proprietary AI memory: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://python-markdown.github.io/reference/ ; https://bleach.readthedocs.io/en/latest/clean.html. Recheck before upgrading; freeze the versions actually tested.
AGENTS.md
# Agent instructions · Craft indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, Markdown vault with rebuildable SQLite index, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, markdown, bleach. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - SQLite is a rebuildable index; it must not become a second competing source of document truth. - Filenames alone are brittle identities for linked documents. - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - Export without an import or restore rehearsal is not verified portability.
BUILD_PLAN.md
# Build plan · Craft Build a local document library with portable Markdown and safe backlinks. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · File-backed writing File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. ### Steps 1. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Files: `features/file_backed_writing.py`, `templates/file_backed_writing.html` 2. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Files: `features/file_backed_writing.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_file_backed_writing.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] A note named ../../outside cannot write outside the vault. ### Watch out - SQLite is a rebuildable index; it must not become a second competing source of document truth. ## Phase 3 · Links and navigation Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. ### Steps 1. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Files: `features/links_and_navigation.py`, `templates/links_and_navigation.html` 2. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Files: `features/links_and_navigation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_links_and_navigation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Searching a unique phrase finds the right note after an index rebuild. ### Watch out - Filenames alone are brittle identities for linked documents. ## Phase 4 · Portable presentation Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. ### Steps 1. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Files: `features/portable_presentation.py`, `templates/portable_presentation.html` 2. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Files: `features/portable_presentation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_presentation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Export and reimport preserve both notes, the image and links. - [ ] An embedded script in Markdown cannot execute in preview or print. ### Watch out - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. ## Phase 5 · Portable delivery and clean-start proof Finish the Craft replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory ## After v1, if you want it - Extend portable presentation only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links.
.env.example
# Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/craft # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
PRODUCT.md
# Craft · product brief ## Problem The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Craft, write visually polished documents, link them, and export a portable personal library. The hard boundary is native apps, sync, publishing, collaboration, and strong block-editor polish, plus sync, collaboration, and capture polish. ## Product outcome An operated version of a local document library with portable Markdown and safe backlinks, with authorized access, restore evidence and honest scope limits. ## Target user A builder who needs a maintainable product foundation, not a one-off demo. ## Required capabilities - macOS, Windows, or Linux - local folder access - optional sync folder chosen by the user ## Explicit non-goals for v1 - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish - frictionless mobile capture - real-time team editing - hosted publishing - proprietary AI memory ## Success criteria - Editing a file outside the app triggers a conflict instead of overwriting it. - Renaming a linked note preserves its incoming link and backlink. - Export and reimport preserve both notes, the image and links. - A private-data authorization check passes using a second identity. - An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - README names the excluded vendor capabilities and actual provider/hosting costs.
BRIEF.md
# Build brief · Craft The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a local document library with portable Markdown and safe backlinks as a bounded replacement for Craft. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: Markdown vault with rebuildable SQLite index. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: markdown, bleach. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - notes(id,title,path,content_hash) - links(source_id,target_id) - tags(note_id,tag) - revisions(id,note_id,hash,snapshot_path) - Markdown files in a user-selected vault are canonical - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: Two Markdown notes linked by stable note ids, an image and an externally edited file. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Craft acceptance sample: Create synthetic sample data before implementation: Two Markdown notes linked by stable note ids, an image and an externally edited file. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a local document library with portable Markdown and safe backlinks. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start file-backed writing until these checks pass. ### Phase 2 · File-backed writing Build: File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. - Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: SQLite is a rebuildable index; it must not become a second competing source of document truth. Done when: Editing a file outside the app triggers a conflict instead of overwriting it. A note named ../../outside cannot write outside the vault. Do not build yet: Do not start links and navigation until these checks pass. ### Phase 3 · Links and navigation Build: Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. - Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Filenames alone are brittle identities for linked documents. Done when: Renaming a linked note preserves its incoming link and backlink. Searching a unique phrase finds the right note after an index rebuild. Do not build yet: Do not start portable presentation until these checks pass. ### Phase 4 · Portable presentation Build: Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. - Export the entire vault with an id/path manifest and implement import preview plus index rebuild. - Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. Done when: Export and reimport preserve both notes, the image and links. An embedded script in Markdown cannot execute in preview or print. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Craft replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - This is a local document library with portable Markdown and safe backlinks; full Craft feature parity, vendor hosting and support are not included. - native apps, sync, publishing, collaboration, and strong block-editor polish: retain the paid product if this capability is essential; it is outside this bounded build. - frictionless mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - real-time team editing: retain the paid product if this capability is essential; it is outside this bounded build. - hosted publishing: retain the paid product if this capability is essential; it is outside this bounded build. - proprietary AI memory: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://python-markdown.github.io/reference/ ; https://bleach.readthedocs.io/en/latest/clean.html. Recheck before upgrading; freeze the versions actually tested.
ARCHITECTURE.md
# Architecture · Craft ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | Markdown vault with rebuildable SQLite index | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | markdown, bleach | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Modules Each module has one owner concern and a documented way to replace it. | Module | Owns | How to replace it | | --- | --- | --- | | Data and identity | notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical | Keep stable ids and a versioned repository interface; migrate storage behind it with a fixture round-trip. | | File-backed writing | Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. | Keep the acceptance contract: Editing a file outside the app triggers a conflict instead of overwriting it. Replace only this module after replaying its fixture; preserve ids and existing records. | | Links and navigation | Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. | Keep the acceptance contract: Renaming a linked note preserves its incoming link and backlink. Replace only this module after replaying its fixture; preserve ids and existing records. | | Portable presentation | Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. | Keep the acceptance contract: Export and reimport preserve both notes, the image and links. Replace only this module after replaying its fixture; preserve ids and existing records. | | Operations | Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. | Change host or backup destination only after an isolated restore and authorization check. | ## Configuration Every runtime setting is an environment variable documented in `.env.example`, validated at startup, with a safe local default wherever one exists. - `DATA_DIR` · required · A new private folder this application creates on first run; never serve it as static files. - `SECRET_KEY` · required, secret · Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. - `APP_MODE` · required · Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. - `SITE_URL` · required · The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. ## Production baseline - Security: least privilege, input validation at every boundary, secret redaction in logs, rate limits on abuse-prone paths, no invented security primitives. - Data: explicit schema and migrations, transactional writes where integrity matters, backup and restore procedures that have been exercised. - Integrations: adapters around third-party providers, idempotent webhook or job processing, bounded retries, timeouts. - Observability: structured logs with request or operation ids, an error-tracking hook, and health and readiness checks where a server exists. - Quality: unit tests for domain rules, integration tests at module boundaries, one end-to-end test of the critical path. ## Decision records For each dependency in the stack table, keep a short note: why it was chosen, its failure mode, and how it is replaced. Do not add infrastructure until a requirement in `PRODUCT.md` justifies it.
AGENTS.md
# Agent instructions · Craft product build - Read `PRODUCT.md` and `ARCHITECTURE.md` before changing code. The stack is fixed: Python 3.12+ and Flask, Markdown vault with rebuildable SQLite index, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, markdown, bleach. - Implement milestone by milestone from `MILESTONES.md`; keep each change reviewable and leave the application runnable at every commit. - Treat authentication, payments, encryption, imports, webhooks and destructive actions as high-risk boundaries when present. - Never invent cryptography or silently weaken a requirement to make a check pass. - Put every external service behind an interface with a deterministic fake for tests. - Add migrations and rollback or recovery notes for every persistent data change. - Log useful operational context without credentials, tokens, passwords or personal data. - Update documentation and run every check before completing a milestone. ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - SQLite is a rebuildable index; it must not become a second competing source of document truth. - Filenames alone are brittle identities for linked documents. - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. - Export without an import or restore rehearsal is not verified portability. - Product mode is additional engineering, not a switch that makes a local prototype production-ready.
MILESTONES.md
# Delivery milestones · Craft Estimated effort: **multi-day** for the indie phases; the production-only milestones add the trust and operability layer. ## M1 · Local foundation and data contract Create the runnable local foundation for a local document library with portable Markdown and safe backlinks, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata markdown bleach python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: notes(id,title,path,content_hash); links(source_id,target_id); tags(note_id,tag); revisions(id,note_id,hash,snapshot_path); Markdown files in a user-selected vault are canonical. Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: Two Markdown notes linked by stable note ids, an image and an externally edited file. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## M2 · File-backed writing File-backed writing for Craft: Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. ### Steps 1. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Implement a plain Markdown editor that saves via temporary file and atomic replace; index titles and hashes in SQLite. Files: `features/file_backed_writing.py`, `templates/file_backed_writing.html` 2. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Restrict all paths to the vault; compare hashes before saving and offer reload or save-as on external edits. Files: `features/file_backed_writing.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Editing a file outside the app triggers a conflict instead of overwriting it. Then check: A note named ../../outside cannot write outside the vault. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_file_backed_writing.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] A note named ../../outside cannot write outside the vault. ### Watch out - SQLite is a rebuildable index; it must not become a second competing source of document truth. ## M3 · Links and navigation Links and navigation for Craft: Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. ### Steps 1. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Resolve note links by stable ids, render backlinks and provide keyboard search over titles and text. Files: `features/links_and_navigation.py`, `templates/links_and_navigation.html` 2. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Implement rename as a title/path change that preserves id; show unresolved links rather than silently creating notes. Files: `features/links_and_navigation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Renaming a linked note preserves its incoming link and backlink. Then check: Searching a unique phrase finds the right note after an index rebuild. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_links_and_navigation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Searching a unique phrase finds the right note after an index rebuild. ### Watch out - Filenames alone are brittle identities for linked documents. ## M4 · Portable presentation Portable presentation for Craft: Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. ### Steps 1. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Render sanitized Markdown previews with local attachments and readable print styles; disable raw HTML. Files: `features/portable_presentation.py`, `templates/portable_presentation.html` 2. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Export the entire vault with an id/path manifest and implement import preview plus index rebuild. Files: `features/portable_presentation.py` 3. Exercise the acceptance fixture Use Two Markdown notes linked by stable note ids, an image and an externally edited file. Check: Export and reimport preserve both notes, the image and links. Then check: An embedded script in Markdown cannot execute in preview or print. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_presentation.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Export and reimport preserve both notes, the image and links. - [ ] An embedded script in Markdown cannot execute in preview or print. ### Watch out - This is a local web editor; native Craft layout fidelity and proprietary sync are excluded. ## M5 · Portable delivery and clean-start proof Finish the Craft replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: File-backed writing; Links and navigation; Portable presentation. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## M6 · Operate and share with access controls (production only) Product-builder only: make a local document library with portable Markdown and safe backlinks operable for its stated audience before allowing remote access. ### Steps 1. Establish owner access before exposure Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. Files: `ARCHITECTURE.md`, `OPERATIONS.md` 2. Deploy a monitored service Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Files: `Caddyfile`, `OPERATIONS.md` ```sh waitress-serve --listen=127.0.0.1:5000 app:app ``` 3. Rehearse loss and recovery Add a scheduled encrypted off-host backup using this procedure: Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. Files: `OPERATIONS.md`, `release-checklist.md` ### Done when - [ ] An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. - [ ] A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. - [ ] Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. ### Watch out - Product mode is additional engineering, not a switch that makes a local prototype production-ready.
OPERATIONS.md
# Operations · Craft ## Backup Pause edits and snapshot the whole Markdown vault including attachments and revision snapshots; the SQLite search index is rebuildable. ## Restore Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: Two Markdown notes linked by stable note ids, an image and an externally edited file. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Do a restore drill before the first real user, and write the date here when it passes. ## Monitoring Check HTTP availability, free disk, backup age and domain failures for File-backed writing, Links and navigation, Portable presentation. Alert without logging private payloads. ## Incident checklist Pause outbound jobs and public intake as appropriate, preserve redacted diagnostics, restore an isolated verified backup, rotate affected credentials and reconcile uncertain effects before reopening. 1. Contain the issue without destroying evidence or user data. 2. Record the timeline and affected scope. 3. Rotate exposed secrets and revoke compromised sessions or credentials. 4. Restore from a verified backup when needed. 5. Document the root cause, the remediation and the regression test. ## Release gate - [ ] Editing a file outside the app triggers a conflict instead of overwriting it. - [ ] Renaming a linked note preserves its incoming link and backlink. - [ ] Export and reimport preserve both notes, the image and links. - [ ] A private-data authorization check passes using a second identity. - [ ] An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - [ ] README names the excluded vendor capabilities and actual provider/hosting costs. ## Launch constraint Do not market omitted Craft capabilities as implemented. The non-goals in `PRODUCT.md` remain user-visible limitations until they are deliberately delivered.
.env.example
# Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/craft # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
$ choose a build depth, inspect the files, then open the complete pack in your agent
People still pay for Craft because people keep paying when the note system is trusted across every device and disappears into their daily capture habits. The recurring cost buys file watching, conflict handling, indexing, mobile apps, encryption, backups, and migrations, not just the visible interface.
xnative apps, sync, publishing, collaboration, and strong block-editor polish
xfrictionless mobile capture
xreal-time team editing
xhosted publishing
xproprietary AI memory
share on X ↗"I just replaced Craft ($10/mo) with one prompt"
Don't feel like building it? These folks already made it free.
AppFlowyA portable document workspace that trades Craft's sheen for local control.open source↗
AFFiNEPolished documents, links and canvases, with local workspaces and usable exports.free↗
ObsidianLinked documents in ordinary Markdown; beautiful publishing is your own department.free↗all 3 free alternatives to Craft →· no votes, no pay-to-list · just what's real
Craft pricing
| plan | monthly | annual (per mo) | what you get |
|---|---|---|---|
| starter | $0/user | $0/user | 1,500 content blocks; 1 GB storage; 25 MB/file; 7-day version history; 15 AI credits |
| plus | $10/user | $8/user | Unlimited documents; 5 spaces; 1 TB/space; 5 GB/file; 30-day history; 50 AI credits/month |
| family | $18 | $15 | 2–6 accounts total; 5 shared family spaces; each member gets Plus and 5 personal 1 TB spaces |
| team | $60 | $50 | Up to 10 members; 25 shared team spaces; every member gets Plus and 5 personal 1 TB spaces |
| education | $0/user | $0/user | Eligible students/educators: unlimited documents; 5 spaces; 250 GB total; 1 GB/file; 15 lifetime AI credits |
| larger teams | custom | — | More than 10 members; custom seat/space terms |
free tierStarter: 1,500 blocks, 1 GB storage, 25 MB/file, 7-day history and 15 AI credits
billingmonthly + annual; direct subscriptions have a 14-day refund window; App Store/Setapp terms differ
hidden costsFamily and Team are flat bundles with hard member ceilings (6 and 10 total). AI is credit-limited even on paid plans. Education requires yearly re-verification; larger teams need a quote.
verified 2026-08-13 · source ↗
Vibecode Craft
Kinda. The core of Craft is buildable in a weekend with the prompt on this page, but there are real gaps: native apps, sync, publishing, collaboration, and strong block-editor polish, frictionless mobile capture. Read the honest list above before committing.
How much does Craft cost?
Craft costs about $10/month (Plus, checked 2026-07-31), which is $120 per year.
What do I lose by replacing Craft?
Honestly: native apps, sync, publishing, collaboration, and strong block-editor polish; frictionless mobile capture; real-time team editing; hosted publishing; proprietary AI memory. If any of those are load-bearing for you, keep paying.
Is there an open-source alternative to Craft?
Yes: AppFlowy (A portable document workspace that trades Craft's sheen for local control.) AFFiNE (Polished documents, links and canvases, with local workspaces and usable exports.) Obsidian (Linked documents in ordinary Markdown; beautiful publishing is your own department.) All 3 curated free alternatives are at vibecodeit.com/craft/alternatives. The prompt is for when you want it exactly your way.