Build QuillBot

The build, in order

1. 1

   Local foundation and data contract

   hideshow

   Create the runnable local foundation for a local paraphrasing desk with protected facts and visible alternatives, including the real schema and acceptance fixture.

   1. 1.1Create 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.pyrequirements.txt.env.example.gitignore

      terminalcopy

      python -m venv .venv
      python -m pip install Flask Flask-WTF python-dotenv waitress tzdata
      python -m pip freeze > requirements.txt
      python -m flask --app app run --host 127.0.0.1

   2. 1.2Implement storage and seed the named fixture

      For database-backed state create schema.sql and db.py using this model: documents(id,title,text,revision); requests(id,document_id,revision,mode,protected_json); candidates(id,request_id,text,model,state); glossary(term,replacement); decisions(id,candidate_id,action,at). 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: A paragraph containing a person name, a date and a monetary amount that must survive rewriting. Re-running init must not erase data.

      Files schema.sqldb.pymanage.pyfixtures/README.md

      terminalcopy

      python manage.py init
      python manage.py seed

   3. 1.3Protect 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.pytemplates/base.htmltest/test_foundation.py

   4. 1.4Verify the selected local model

      Create providers/local_model.py with a POST /api/chat adapter using the configured local model and stream:false. Validate structured output, bound input/output, set a timeout and reject cloud models or non-loopback inference URLs. Add a probe that sends one harmless prompt and a test double for deterministic tests. Missing model setup must disable generation with a specific error while leaving editing usable.

      Files providers/local_model.pyscripts/model_probe.py

      terminalcopy

      python scripts/model_probe.py

   done when · tick each as it passes

   • 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.

   next phase
2. 2

   Source and constraints

   hideshow

   Source and constraints for QuillBot: Create a plain-text editor with selected-span rewriting and standard/shorter/formal modes.

   1. 2.1Create a plain-text editor with selected-span rewriting and standard/shorter/formal modes.

      Create a plain-text editor with selected-span rewriting and standard/shorter/formal modes.

      Files features/source_and_constraints.pytemplates/source_and_constraints.html

   2. 2.2Let the user mark names, dates, numbers and quotations as protected; retain the original selection and revision.

      Let the user mark names, dates, numbers and quotations as protected; retain the original selection and revision.

      Files features/source_and_constraints.py

   3. 2.3Exercise the acceptance fixture

      Use A paragraph containing a person name, a date and a monetary amount that must survive rewriting. Check: The preview shows the exact selected text and protected tokens before generation. Then check: An empty selection cannot trigger a paid or local inference request. 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_source_and_constraints.py

      terminalcopy

      python -m unittest discover -s test

   done when · tick each as it passes

   • The preview shows the exact selected text and protected tokens before generation.
   • An empty selection cannot trigger a paid or local inference request.

   watch out

   • Paraphrasing is not a way to manufacture facts or erase the need to credit a source.

   next phase
3. 3

   Generate alternatives

   hideshow

   Generate alternatives for QuillBot: Call the local model for two bounded alternatives and validate required protected tokens before showing them as usable.

   1. 3.1Call the local model for two bounded alternatives and validate required protected tokens before showing them as usable.

      Call the local model for two bounded alternatives and validate required protected tokens before showing them as usable.

      Files features/generate_alternatives.pytemplates/generate_alternatives.html

   2. 3.2Render a word diff for each candidate and label failed constraints instead of silently repairing them.

      Render a word diff for each candidate and label failed constraints instead of silently repairing them.

      Files features/generate_alternatives.py

   3. 3.3Exercise the acceptance fixture

      Use A paragraph containing a person name, a date and a monetary amount that must survive rewriting. Check: A candidate that changes the monetary amount is flagged and cannot be accepted as constraint-passing. Then check: A model outage leaves the source and selection intact. 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_generate_alternatives.py

      terminalcopy

      python -m unittest discover -s test

   done when · tick each as it passes

   • A candidate that changes the monetary amount is flagged and cannot be accepted as constraint-passing.
   • A model outage leaves the source and selection intact.

   watch out

   • Token preservation is a mechanical check; a human still needs to check whether meaning changed.

   next phase
4. 4

   Accept and export

   hideshow

   Accept and export for QuillBot: Apply only the selected candidate if the original revision matches; offer undo as a new revision.

   1. 4.1Apply only the selected candidate if the original revision matches; offer undo as a new revision.

      Apply only the selected candidate if the original revision matches; offer undo as a new revision.

      Files features/accept_and_export.pytemplates/accept_and_export.html

   2. 4.2Export original, accepted text and decision history in JSON plus a plain-text final document.

      Export original, accepted text and decision history in JSON plus a plain-text final document.

      Files features/accept_and_export.py

   3. 4.3Exercise the acceptance fixture

      Use A paragraph containing a person name, a date and a monetary amount that must survive rewriting. Check: Accepting alternative two leaves alternative one recorded but unapplied. Then check: Undo restores the exact original paragraph. 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_accept_and_export.py

      terminalcopy

      python -m unittest discover -s test

   done when · tick each as it passes

   • Accepting alternative two leaves alternative one recorded but unapplied.
   • Undo restores the exact original paragraph.

   watch out

   • Plagiarism detection, proprietary paraphrase quality and across-app extensions are excluded.

   next phase
5. 5

   Portable delivery and clean-start proof

   hideshow

   Finish the QuillBot replacement with a documented first-run path and a recoverable export.

   1. 5.1Write the user-facing runbook

      Document prerequisites, every configuration variable, data locations and the three domain workflows: Source and constraints; Generate alternatives; Accept and export. 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. 5.2Create and rehearse a recoverable backup

      Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for quillbot. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A paragraph containing a person name, a date and a monetary amount that must survive rewriting. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy.

      Files OPERATIONS.mdscripts/backup.py

   3. 5.3Reproduce 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.mdverification.md

      terminalcopy

      python -m pip install -r requirements.txt
      python -m unittest discover -s test

   done when · tick each as it passes

   • 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.