Skip to content

JustinMiehle/meditation

Repository files navigation

Meditation App

A simple and elegant meditation timer to enhance your mindfulness practice.

After a few years of meditation, I realized that I really appreciated the church bells in my neighborhood which would ring every 15 minutes. It allowed me to not have to set a timer, and not use a guided meditation, but still get regular reminders to focus my attention, and it gave me the a sense of time passing by, allowing me to flexibly decide how long to meditate on a given day.

Do with it whatever you may, I'll add Vercel Hosting if this gets any attention :)

Features

  • Clean and intuitive user interface
  • Customizable meditation timer
  • Soothing bell sounds at regular intervals
  • Responsive design for desktop and mobile devices

Tech Stack

  • React
  • TypeScript
  • TailwindCSS
  • ShadCN UI
  • Web Audio API

Getting Started

Prerequisites

  • Node.js (v14 or later) or Bun
  • npm, yarn, or bun

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/meditation-app.git

  2. Navigate to the project directory:

    cd meditation-app

  3. Install dependencies:

    npm install

    or

    yarn install

    or

    bun install

  4. Start the development server:

    npm run dev

    or

    yarn dev

    or

    bun run dev

  5. Open your browser and visit http://localhost:3000

Usage

  1. Click the play button to start the meditation timer
  2. The app will play a bell sound at the start and every minute
  3. Every 5 minutes, a different bell sound will play
  4. Every 10 minutes, a third distinct bell sound will play
  5. Click the pause button to pause the timer
  6. Click the reset button to stop the timer and reset it to 00:00

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Contact

Justin Miehle - @justinmiehle

Project Link: https://github.com/justinmiehle/meditation-app

About

Possibly the simplest Meditation App you've ever seen

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published