{"id":26585098,"url":"https://github.com/stacksjs/pomodoro","last_synced_at":"2025-03-23T10:20:48.994Z","repository":{"id":282312778,"uuid":"948168446","full_name":"stacksjs/pomodoro","owner":"stacksjs","description":"🍅 A minimal, functional, yet simple Pomodoro menubar app, to help stay focussed.","archived":false,"fork":false,"pushed_at":"2025-03-21T03:54:12.000Z","size":5978,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-21T04:33:06.746Z","etag":null,"topics":["app","macos","menubar","pomodoro","swift","swiftui","timer"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stacksjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stacksjs","chrisbbreuer"]}},"created_at":"2025-03-13T21:35:22.000Z","updated_at":"2025-03-20T18:34:25.000Z","dependencies_parsed_at":"2025-03-13T22:42:19.144Z","dependency_job_id":null,"html_url":"https://github.com/stacksjs/pomodoro","commit_stats":null,"previous_names":["stacksjs/pomodoro"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Fpomodoro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Fpomodoro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Fpomodoro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Fpomodoro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stacksjs","download_url":"https://codeload.github.com/stacksjs/pomodoro/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244947927,"owners_count":20536734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["app","macos","menubar","pomodoro","swift","swiftui","timer"],"created_at":"2025-03-23T10:20:48.352Z","updated_at":"2025-03-23T10:20:48.958Z","avatar_url":"https://github.com/stacksjs.png","language":"Swift","funding_links":["https://github.com/sponsors/stacksjs","https://github.com/sponsors/chrisbbreuer"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\".github/art/cover.jpg\" alt=\"Social Card of this repo\"\u003e\u003c/p\u003e\n\n[![npm version][npm-version-src]][npm-version-href]\n[![GitHub Actions][github-actions-src]][github-actions-href]\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\u003c!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] --\u003e\n\u003c!-- [![Codecov][codecov-src]][codecov-href] --\u003e\n\n# Pomodoro.app\n\nA minimal, functional, yet simple Pomodoro menubar app to help you stay focused. Built exclusively for macOS.\n\n## Features\n\n- 🍎 **macOS Native** - Built with SwiftUI for a seamless Mac experience\n- 🔔 **Menu Bar App** - Always accessible from your menu bar\n- ⏱️ **Customizable Timers** - Set your own work and break durations\n- 🪟 **Detachable Timer Window** - Pop out the timer when you need it visible\n- 🔊 **Audio Notifications** - Get alerted when your timer completes\n- ⚙️ **Configurable Settings** - Customize to fit your workflow\n\n## Getting Started\n\n### Prerequisites\n\n- macOS 11.0 (Big Sur) or later\n- Xcode 13.0 or later\n- [Bun](https://bun.sh/) for running build scripts (optional)\n\n### Development Setup\n\n1. **Clone the repository**\n\n```bash\ngit clone https://github.com/stacksjs/pomodoro.git\ncd pomodoro\n```\n\n2. **Open the project in Xcode**\n\n```bash\nopen src/Timer.xcodeproj\n```\n\n3. **Build and run the app**\n\n- Select the \"Timer\" scheme in Xcode\n- Choose your Mac as the run destination\n- Click the Run button (▶️) or press Cmd+R\n\n### Building from Source\n\nIf you prefer to build from the command line:\n\n```bash\n# Build the app\nbun run build\n\n# cd src \u0026\u0026 xcodebuild -project Timer.xcodeproj -scheme Timer -configuration Release\n\n# The built app will be in src/build/Release/Timer.app\n```\n\n### Installing the App\n\nAfter building, you can install the app by:\n\n1. Locating the built `Timer.app` in `src/build/Release/`\n2. Dragging it to your Applications folder\n\n## Usage\n\n1. **Launch the app** - The timer will appear in your menu bar\n2. **Click the menu bar icon** - Opens the timer interface\n3. **Set your timer** - Use the slider or preset buttons (25, 5, or 10 minutes)\n4. **Start the timer** - Click \"Start\" to begin your focus session\n5. **Detach the timer** - Click \"Detach Timer\" to open a floating window\n6. **Configure settings** - Click \"Settings\" to customize timer presets\n\n## Development\n\nThis project uses:\n\n- SwiftUI for the user interface\n- Combine for reactive programming\n- AVFoundation for audio playback\n- AppKit for macOS-specific functionality\n\n### Project Structure\n\n- `TimerApp.swift` - Main app entry point\n- `AppDelegate.swift` - Handles menu bar integration\n- `ContentView.swift` - Main timer interface\n- `TimerViewModel.swift` - Core timer logic\n- `TimerState.swift` - Timer state management\n- `settingsView.swift` - Settings interface\n- `timerView.swift` - Detachable timer window\n\n## Testing\n\n```bash\nbun test\n```\n\n## Changelog\n\nPlease see our [releases](https://github.com/stacksjs/pomodoro/releases) page for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.\n\n## Community\n\nFor help, discussion about best practices, or any other conversation that would benefit from being searchable:\n\n[Discussions on GitHub](https://github.com/stacksjs/pomodoro/discussions)\n\nFor casual chit-chat with others using this package:\n\n[Join the Stacks Discord Server](https://discord.gg/stacksjs)\n\n## Postcardware\n\n“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where `Pomodoro.app` is being used! We showcase them on our website too.\n\nOur address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎\n\n## Credits\n\n- [@YYUUGGOO](https://github.com/YYUUGGOO) - for the original [Cloud](https://github.com/YYUUGGOO/Cloud) implementation\n\n## Sponsors\n\nWe would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.\n\n- [JetBrains](https://www.jetbrains.com/)\n- [The Solana Foundation](https://solana.com/)\n\n## License\n\nThe MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.\n\nMade with 💙\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/pomodoro?style=flat-square\n[npm-version-href]: https://npmjs.com/package/@stacksjs/pomodoro\n[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/pomodoro/ci.yml?style=flat-square\u0026branch=main\n[github-actions-href]: https://github.com/stacksjs/pomodoro/actions?query=workflow%3Aci\n\n\u003c!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/ts-starter/main?style=flat-square\n[codecov-href]: https://codecov.io/gh/stacksjs/ts-starter --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacksjs%2Fpomodoro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstacksjs%2Fpomodoro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacksjs%2Fpomodoro/lists"}