Skip to content

ProdigyRahul/clearbreath

ClearBreath logo

ClearBreath

A free, open-source pranayama and breathing exercise platform.

Server CI Mobile CI License: MIT Version 0.0.2

Why ClearBreath

Most breathing and mindfulness apps lock core routines behind subscriptions, interrupt practice with ads, or ask users to trust a closed product with personal wellness data. ClearBreath takes the opposite approach.

ClearBreath is built to stay always free, open source, and easy to inspect. No paywalls. No subscriptions. No ads. No data selling.

It is designed for practitioners who want guided pranayama sessions, streaks, stats, and gentle structure without extra friction.

Screenshots

Splash   Techniques   Breathing session   Leaderboard

Tech Stack

Component Technology Directory
Server Go 1.25, Chi, PostgreSQL 17, Redis 7 server/
Mobile Flutter 3.38, Riverpod, Drift apps/mobile/
Web Astro, Tailwind CSS apps/web/
CI/CD GitHub Actions .github/workflows/

Quick Start

Prerequisites

  • Go 1.25+
  • Flutter 3.38+
  • Bun 1.3+
  • PostgreSQL 17
  • Redis 7+
  • Docker

If Flutter is not on your PATH, pass FLUTTER=~/sdk/flutter/bin/flutter to mobile make commands.

Clone the Repo

git clone https://github.com/purebreathlabs/clearbreath.git
cd clearbreath

Install Dependencies

make setup

Configure Local Environment

cp .env.example server/.env

Start Local Services

make docker-up

Run the API

make server-dev

Verify the API

curl http://localhost:8080/health

Run the Mobile App

make mobile-run

By default, the mobile app points at the hosted API. For Android emulator testing against your local API, use:

make mobile-run API_BASE_URL=http://10.0.2.2:8080 MOBILE_RUN_ARGS="--dart-define=DEV_AUTH_ENABLED=true"

For a physical Android device on the same Wi-Fi network, replace 10.0.2.2 with your machine's local IP.

Run the Web App

make web-dev

Project Structure

.
├── .github/
├── apps/
│   ├── mobile/
│   └── web/
├── assets/
├── scripts/
├── server/
├── Makefile
├── VERSION
└── melos.yaml

Current Focus

  • Preparing the Google Play launch, with the first release currently pending review
  • Polishing onboarding and the first-session experience for new users
  • Organizing post-launch alpha testing and early feedback collection for the first live users

Roadmap

  • App Store launch
  • Expanded alpha and beta testing program
  • Documentation website
  • Landing page improvements
  • Community features and improvements

Contributing

Contributions are welcome across code, docs, tests, and community operations. Please read CONTRIBUTING.md before opening a pull request. All contributor pull requests should target the dev branch.

Production deployment infrastructure is maintainer-only and kept outside the public repository.

Community

Thank you to everyone who contributes to ClearBreath.

Sponsors

ClearBreath is and will remain always free. If you find it valuable, consider sponsoring the project to help cover hosting and development costs: https://github.com/sponsors/prodigyrahul

About PureBreathLabs

PureBreathLabs builds breathing tools that stay accessible to everyone. The goal is simple: always free, open source, no paywalls, and no subscriptions.

Maintainers

License

This project is licensed under the MIT License. See LICENSE for details.

About

Free, open-source pranayama and breathing app

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors