Files
q-edit/README.md
T
2025-09-06 12:05:21 -04:00

28 lines
926 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# QEdit
Static singlepage app for reviewing, editing, and cleaning up your published QDN content.
- App: `index.html`, `style.css`, `script.js`
- Modules: `src/` and `scripts/` (hash/prefs/pagination, render helpers)
- Docs: see `docs/` (architecture, ADRs, testing, prior release notes)
## Quick start
- Serve locally: `node scripts/serve.mjs` → http://localhost:5173
- Open in a Qortal browser or with the extension and authenticate.
## Tests
- Run once with coverage: `node node_modules/vitest/vitest.mjs run --coverage`
- Enforce thresholds: `node scripts/ci-check-coverage.mjs`
## Build/Dist
- This app ships as static files. No build step required.
- Create a zip: `bash scripts/make_dist.sh``q-edit_dist.zip`
## Docs
- Start with `docs/design-overview.md`, `docs/architecture.md`, and `docs/changelog.md`.
- Release notes: `docs/RELEASE_NOTES_v1.1.0.md` (latest) and earlier versions in `docs/`.