https://github.com/maskedsyntax/focusbrew

A Pomodoro Timer for better focus.
https://github.com/maskedsyntax/focusbrew

analysis bubbletea cross-platform focus golang linux pomodoro pomodoro-timer task-manager timer tui

Last synced: 9 months ago
JSON representation

A Pomodoro Timer for better focus.

• Host: GitHub
• URL: https://github.com/maskedsyntax/focusbrew
• Owner: MaskedSyntax
• Created: 2021-06-20T19:38:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-11T21:31:06.000Z (about 1 year ago)
• Last Synced: 2025-04-13T20:46:36.460Z (9 months ago)
• Topics: analysis, bubbletea, cross-platform, focus, golang, linux, pomodoro, pomodoro-timer, task-manager, timer, tui
• Language: Python
• Homepage:
• Size: 382 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# FocusBrew 🍵⏳

![Go](https://img.shields.io/badge/Go-1.20+-blue)

![TUI](https://img.shields.io/badge/TUI-BubbleTea-yellowgreen)

![Cross-Platform](https://img.shields.io/badge/Platform-Linux%20|%20Windows%20|%20macOS-blue)

**FocusBrew** is a terminal-based Pomodoro Timer built using **Golang** and the **Bubble Tea** TUI framework. This project is designed to provide a lightweight and distraction-free productivity tool for developers and terminal enthusiasts.

---

## **Project Status**

🚧 **Work in Progress**:  

This project is currently in the **planning phase**, and no code has been written yet. Contributions, ideas, and discussions are welcome as we finalize the architecture and feature set.

---

## **Planned Features**

### **Core Features (MVP)**

- **Pomodoro Timer**:

  - Default work and break durations (25 min work, 5 min short break, 15 min long break).

- **Keyboard Shortcuts**:

  - Start, pause, reset, and quit the timer using intuitive shortcuts.

- **Session Tracking**:

  - Keep track of completed work sessions.

### **Future Enhancements**

- **Customization**:

  - Allow users to configure work, short break, and long break durations.

- **Task Association**:

  - Add tasks to each Pomodoro session for better tracking.

- **Progress Bar**:

  - Visualize timer progress with a terminal-based progress bar.

- **Daily/Weekly Analytics**:

  - Display time spent on tasks or sessions.

- **Desktop Notifications**:

  - Notify users when a session ends.

- **Dark Mode**:

  - Provide light and dark themes for better visual appeal.

---

## **Goals of the Project**

1. **Lightweight**:

   - A terminal-based productivity tool that doesn't rely on a GUI environment.

2. **Cross-Platform**:

   - Compatible with Linux, Windows, and macOS.

3. **Distraction-Free**:

   - Minimalist interface to maximize focus.

---

## **Tech Stack**

- **Language**: Golang

- **Framework**: [Bubble Tea](https://github.com/charmbracelet/bubbletea) for TUI development

---

## **Installation**

⚠️ **Note**: This section will be updated once development starts.

---

## **Roadmap**

### Phase 1: Initial Development

- Implement a basic Pomodoro timer with work and break intervals.

- Add keyboard shortcuts for basic controls (start, pause, reset, quit).

### Phase 2: Feature Expansion

- Allow customization of timer durations.

- Add session tracking and progress visualization.

### Phase 3: Advanced Features

- Introduce task management.

- Add notifications and analytics.

---

## **License**

This project will be licensed under the **MIT License** once development begins.

---

## **Contact**

- **Author**: [Aftaab Siddiqui](https://github.com/MaskedSyntax)

- **Repository**: [FocusBrew](https://github.com/MaskedSyntax/FocusBrew)

Feel free to reach out with ideas, feedback, or questions!