laurence/openscribe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

scaffold: OpenScribe open-source self-hosted AI voice recorder
Some checks failed
ci / firmware (push) Failing after 2s
Details
ci / server (push) Failing after 45s
Details

Browse source 
Bootstrap of the project (M0). Sets up the monorepo, design docs, hardware BOM,
the open API contract, component skeletons, licensing and CI, following the
Default Workflow SOP.

What changed:
- CLAUDE.md + docs/: copied the Default Workflow so sessions load the SOP.
- state/: PROJECT, ARCHITECTURE, DECISIONS, TODO, NOTES filled in for OpenScribe.
  ARCHITECTURE captures the four-part design (firmware, server, app, case) and the
  three sync paths; DECISIONS records the hardware, AI-stack, storage, app and
  licensing choices; TODO lays out milestones M1-M9.
- hardware/BOM.md: two build options (compact XIAO ESP32-S3 Sense; dev ESP32-S3 +
  I2S mic + SD), wiring/pinout, indicative cost.
- api/openapi.yaml: the completely open API (device + server surfaces), including
  recording list/download/delete and exports (wav/ogg/txt/srt/vtt/md/json).
- firmware/: PlatformIO ESP32-S3 project, two board profiles, pin map, boot scaffold
  with module seams for M1-M4.
- server/: FastAPI skeleton mirroring the OpenAPI, config for self-hosted MinIO,
  faster-whisper and Ollama; stub routes browsable at /docs.
- app/, case/: Flutter app plan; parametric OpenSCAD enclosure.
- Licensing: GPL-3.0 (code), CERN-OHL-S-2.0 (hardware), CC-BY-SA-4.0 (case/docs),
  REUSE-style LICENSES/ with SPDX headers; LICENSING.md explains the split.
- CI: Forgejo Actions workflow builds firmware (both profiles) and lints/imports server.

Why:
- Everything self-hosted and openly licensed per the user's requirements: an open
  API, three sync paths (BLE control, WiFi transfer, independent WiFi upload on
  charge to generic cloud storage), and a full self-hosted transcription+summary stack.

Notes:
- No custom PCB in v1; off-the-shelf modules. Physical verification waits on parts.
- Component code is stubs at M0; features land milestone by milestone, each as its
  own branch/PR per the workflow.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Laurence 2026-07-03 10:21:37 +01:00
commit 031074c9a9
36 changed files with 2922 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

26
LICENSING.md Normal file
View file

@ -0,0 +1,26 @@
# Licensing
OpenScribe is multi-part, so it uses a licence appropriate to each part. All licence
texts are in [`LICENSES/`](LICENSES/). The top-level [`LICENSE`](LICENSE) is a copy of
GPL-3.0 so the forge detects the primary code licence.
| Part | Paths | Licence |
|------|-------|---------|
| Firmware, server, app (all source code) | `firmware/`, `server/`, `app/` | **GPL-3.0-only** |
| Hardware design (BOM, wiring, any future PCB) | `hardware/` | **CERN-OHL-S-2.0** |
| 3D case models and documentation | `case/`, `docs/`, `state/`, `*.md` | **CC-BY-SA-4.0** |
Rationale: strong copyleft keeps derivatives open, which is the point of the project.
CERN-OHL-S and CC-BY-SA are the standard reciprocal licences for open hardware and for
creative/documentation content respectively. See `state/DECISIONS.md` for the full record.
`LICENSES/Apache-2.0.txt` is included for a possible future permissive client SDK; it is
not applied to anything yet.
Where practical, files carry an `SPDX-License-Identifier:` header so the licensing is
machine-checkable (REUSE style). The OpenAPI spec `api/openapi.yaml` is CC-BY-SA-4.0 as
documentation of the interface.
The name "Plaud" and any Plaud trademarks belong to their owner. OpenScribe is an
independent, clean-room, open-source project inspired by that class of device. It is not
affiliated with, endorsed by, or derived from Plaud.