An open API service indexing awesome lists of open source software.

https://github.com/paulchiu/lean-coffee-timer

A simple, customizable timer for facilitating Lean Coffee meetings with extendable discussions and audio notifications.
https://github.com/paulchiu/lean-coffee-timer

lean-co react timer typesc vite

Last synced: 3 months ago
JSON representation

A simple, customizable timer for facilitating Lean Coffee meetings with extendable discussions and audio notifications.

Awesome Lists containing this project

README

          

# Lean Coffee Timer

[![CI](https://github.com/paulchiu/lean-coffee-timer/actions/workflows/ci.yml/badge.svg)](https://github.com/paulchiu/lean-coffee-timer/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/paulchiu/lean-coffee-timer/graph/badge.svg?token=FWQEFXSRBB)](https://codecov.io/gh/paulchiu/lean-coffee-timer)
[![License](https://img.shields.io/github/license/paulchiu/lean-coffee-timer)](https://github.com/paulchiu/lean-coffee-timer/blob/main/LICENSE)

A simple timer for tracking Lean Coffee meetings.

## Features

- ⏱️ Customizable topic time settings.
- ⏳ Extendable time for when discussions run long.
- 🔔 Audio notifications when time is running low.
- 🌓 Dark/light theme toggle.
- 📱 Mobile friendly.

## Usage

1. Set your desired topic time (default: 5 minutes).
2. Set your extension time (default: 2 minutes).
3. Click "Start Discussion" to begin the timer.
4. When time is running low, you'll hear beep notifications.
5. When time expires, you'll hear an alarm.
6. Click "Extend" if the group wants to continue the discussion.
7. Click "Reset" to start over with a new topic.

## Development

### Prerequisites

- Node.js (v20+) with NPM

### Installation

```bash
# Clone the repository
git clone https://github.com/paulchiu/lean-coffee-timer.git
cd lean-coffee-timer

# Install dependencies
npm install
```

### Running locally

```bash
npm run dev
```

The application will be available at http://localhost:5173

### Building for production

```bash
npm run build
```

## Built with

- [Howler](https://howlerjs.com/)
- [Lucide Icons](https://lucide.dev/)
- [React](https://react.dev/)
- [Shadcn](https://ui.shadcn.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Vite](https://vitejs.dev/)

## License

MIT

## Learn More

For more information about Lean Coffee, visit [leancoffee.org](https://www.leancoffee.org)