Skip to content
udirobertPublic

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

306 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Brume

A calm little companion for breathing breaks, getting ready, and checking how sharp you are.

Live Demo: Try Now | Anna App Store: @papa/brume

🎯 What is Brume?

Brume is a mist sprite who breathes with you. Two faces, one character:

  • 🌐 Web app (brumeapp.netlify.app) - the full practice: guided patterns, AI coaching, optional camera feedback (video never leaves your device unprocessed), accounts and history.
  • 🤖 Anna app (anna/, @papa/brume) - the pocket version inside the Anna agent: AI-planned resets, a 3-minute get-ready before calls and interviews, and a 1-minute alertness check. No camera, no account.

Core Philosophy: Progress over perfection, consistency over intensity, mindful awareness over mechanical practice.

🚀 Quick Start

For Users

🌐 Live Demo - Start breathing immediately, no signup required!

For Developers

Prerequisites: Node.js >=24.15.0 <25 (see .nvmrc) and pnpm 12.14.0 (corepack enable reads packageManager).

Install policy: pnpm-workspace.yaml is tracked and applies pnpm 12's default minimumReleaseAge gate for all packages, with exact-pin minimumReleaseAgeExclude exceptions only for the two latest-pinned releases (eslint@10.13.0, lucide-react@1.58.0). The lockfile is multi-document; always install with pnpm install --frozen-lockfile.

# Clone and install
git clone https://github.com/udirobert/brume.git
cd brume
pnpm install --frozen-lockfile

# Start development (includes fallback AI)
pnpm dev  # Opens http://localhost:4556

# Optional: Enable full AI & vision features
cd backend/vision-service
pip install -r requirements.txt
MODEL_DOWNLOAD_ON_START=false python3 main.py &

Works immediately with: 20+ breathing patterns, progress tracking, offline support

📚 Documentation

🚀 Development Guide - Setup, roadmap, and implementation

🏗️ Architecture Guide - System design & technical details

📖 Documentation Hub - Additional guides and resources

🌟 Key Features

🤖 AI-Powered Coaching

  • Optional camera feedback — image frames are sent to Brume's backend and processed with MediaPipe for face-landmark and movement estimates (not a clinical or breath-quality measurement)
  • Personalized insights powered by Cerebras & Llama AI models
  • Zen AI agent for adaptive guidance and encouragement
  • Session intelligence - Detailed metrics and progress tracking

📱 Progressive Web App

  • Works offline after first load
  • Mobile-optimized responsive design
  • Camera integration for vision features

⛓️ Trust layer (quiet by design)

  • Flow Blockchain / Lens Protocol — legacy credential plumbing exists in the codebase, but camera presence does not verify breathing and post-session credential minting is currently not user-facing. Don't treat it as proof of practice.
  • Wallet connect — reserved for credentials; nothing else asks for it

🔒 Privacy & Security

Camera Processing: Optional camera feedback captures JPEG image frames and sends them to Brume's backend, where MediaPipe estimates face landmarks and movement. It is not breathing verification or a clinical measurement — sessions work fully without a camera.

Retention: Session metrics, preferences, and history may persist (local device and Supabase when signed in). Exact retention/ownership policy needs a backend review — see docs/DEPENDENCIES.md for the current dependency and privacy posture.

🤝 Contributing

We welcome contributions from developers, breathing instructors, and wellness practitioners!

Quick Development Commands

pnpm dev            # Start development server
pnpm run build      # Production build
pnpm test           # Run tests
pnpm run lint       # Code quality checks

Frontend startup requires the public Supabase values in .env.local, including for guest use (VITE_SUPABASE_URL, VITE_SUPABASE_ANON_KEY — publishable anon key only, never service keys). Provider/service keys stay backend-side; do not add VITE_* secret keys.

Contribution Types

  • Breathing Patterns - Share traditional techniques
  • Code Development - Improve features and fix bugs
  • Documentation - Help others learn and use the platform
  • Community - Support other users and share experiences

🌍 Roadmap

✅ Completed

  • Core breathing patterns and AI coaching
  • Computer vision system with three performance tiers
  • Flow blockchain integration for NFTs
  • Mobile-first responsive design
  • Lens Protocol social features

🔄 In Development

  • Advanced biometrics (HRV, stress detection)
  • Instructor certification program
  • Multi-language support

📋 Future Plans

  • Mobile app (iOS/Android)
  • Wearable device integration
  • Advanced AI coaching features

📄 License

MIT License - see LICENSE file for details.

🙏 Acknowledgments

Built with respect for ancient breathing traditions and the open source community.


Start your breathing journey today - No signup required, just breathe. 🌬️

Live Demo | Documentation | Community

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages