Skip to content

FasterApiWeb/laughing-chainsaw

Repository files navigation

LibreRing

LibreRing logo

Your body. Your data. No subscription.

CI Deploy Pages MIT License Documentation Live Demo

Documentation · Web Dashboard · Contributing · Security


Open-source Oura Ring client. Connects over Bluetooth LE, stores data locally, writes to Apple Health, and optionally syncs to your own Supabase — no Oura subscription required.

Inspired by LibrePods.

Highlights

Direct BLE Oura Ring 3/4/5 without the official app
Offline-first SQLite / IndexedDB — cloud is optional
Open algorithms Sleep, readiness, HRV scoring you can inspect
Hybrid cloud Supabase Postgres + Cloudflare R2 (your keys)
RE toolkit Python CLIs for protocol research

Live links

Resource URL
Documentation https://fasterapiweb.github.io/laughing-chainsaw/docs/
Web dashboard https://fasterapiweb.github.io/laughing-chainsaw/
Releases https://github.com/FasterApiWeb/laughing-chainsaw/releases

Monorepo structure

apps/web              Next.js dashboard (GitHub Pages)
apps/ios              Swift/SwiftUI + CoreBluetooth + HealthKit
apps/android          Kotlin/Compose scaffold
packages/sdk-ts       @librering/sdk
packages/api-spec     OpenAPI contract
backend/supabase      Postgres schema, RLS, sync RPCs
backend/worker        Cloudflare Worker → R2
core/librering-core   Rust BLE protocol
tools/                Python reverse-engineering toolkit
docs/                 MkDocs documentation source

Quick start

Web dashboard

pnpm install
cp apps/web/.env.example apps/web/.env.local   # optional Supabase
pnpm dev:web

iOS app

cd apps/ios/LibreRing
brew install xcodegen && xcodegen generate
open LibreRing.xcodeproj   # run on physical iPhone

Documentation (local)

pip install -r docs/requirements.txt
pnpm docs:serve    # http://127.0.0.1:8000

Python RE toolkit

cd tools && python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
python scan_oura.py --read-values

Documentation

Guide Description
Concepts Design principles & sync model
Architecture System design
Cloud Setup Supabase + optional R2
Deploy GitHub Pages
Contributing PR guidelines
Open Source Checklist OSS readiness
Protocol BLE specification

Full site: https://fasterapiweb.github.io/laughing-chainsaw/docs/

Roadmap

  • BLE protocol reverse engineering
  • iOS app + HealthKit
  • Web dashboard + cloud sync
  • Monorepo + Supabase/R2 backend
  • MkDocs + CI/CD
  • Background sync (BGTaskScheduler)
  • Android + Health Connect
  • Rust core UniFFI on mobile
  • PyPI / crates.io packages

Security & privacy

Never commit ring auth keys or health captures:

Path Contents
key.hex 16-byte BLE auth key
tools/services.json GATT dump
tools/captures/ Session logs

Report vulnerabilities via SECURITY.md (private advisory).

Legal

Clean-room reverse engineering for interoperability. Not affiliated with Oura Health Oy. See docs/legal.md.

License

MIT — Copyright (c) 2026 FasterApiWeb

About

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors