https://g07cha.github.io/pomodoro/

A classic time management tool in your menubar
https://g07cha.github.io/pomodoro/

macos pomodoro rust tauri timer typescript windows

Last synced: about 2 months ago
JSON representation

A classic time management tool in your menubar

• Host: GitHub
• URL: https://g07cha.github.io/pomodoro/
• Owner: G07cha
• License: mit
• Created: 2015-10-02T15:08:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T15:02:01.000Z (2 months ago)
• Last Synced: 2024-10-29T17:33:14.289Z (2 months ago)
• Topics: macos, pomodoro, rust, tauri, timer, typescript, windows
• Language: Rust
• Homepage: https://g07cha.github.io/pomodoro/
• Size: 2.92 MB
• Stars: 344
• Watchers: 11
• Forks: 45
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-electron-zh - Pomodoro - Timer based on the Pomodoro Technique. (Apps / Open Source)

README

        
# Pomodoro

Time management tool for Windows and macOS inspired by [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). Build with love and [tauri](https://tauri.app/).



  



## Installing

To install the application you can grab the installer for your platform from [the latest release](github.com/G07cha/pomodoro/releases/latest/), in case of macOS you need to open the app for the first time with Cmd + right mouse button as I don't feel like spending money on a license from Apple to notarize a free application. Alternatively you can also build the release yourself by following the guide below.

## Local development

### Prerequisites

- Node.js (preferably installed via [nvm](https://github.com/nvm-sh/nvm) to match local version)

- [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/)

```bash

npm install

```

### Building

To run full app execute the following command:

```bash

npm start

```

To build a release for the platform you're running it on execute the following command:

```bash

TAURI_PRIVATE_KEY=test npm run build

```

It will throw an error `Error invalid utf-8 sequence of 1 bytes from index 0` in the end due to mismatch in updater private key but will create binaries and installers in `src-tauri/target/release/bundle`.

## Release

To release a new version you'll need to have `cargo-bump` package installed:

```bash

cargo install cargo-bump

```

Afterwards you can bump the npm package version with the following command which will also bump the Cargo version:

```bash

npm version (patch|minor|major)

```

And then push it along with the tags to the main branch. Github Actions will create a new draft release and populate it with compiled binaries.

## License

MIT © Konstantin Azizov