Skip to content

Latest commit

 

History

History
207 lines (135 loc) · 7.06 KB

README.md

File metadata and controls

207 lines (135 loc) · 7.06 KB
Raw

Pomatez logo

Pomatez

Stay Focused. Take a Break.


Features . Discord . Development . Installation . Privacy . License

Pomatez Github Downloads Latest Version License

App Preview

✨ Features

  • Customizable rules - it allows you to modify the default Pomodoro configuration based on your personal preferences.

  • Built-in task list - it allows you to create a simple list of todos and mark the items done when it's done.

  • Full-screen breaks - once enabled, it will force you to not continue working during break time by occupying the whole screen of your desktop, but right now it doesn't support multiple monitors.

  • Desktop notification - once enabled, you will get desktop notifications from time to time depending on the notification type you selected. Supported notification types are the following;

    • None - no notification will be shown. default
    • Normal - will show notification in every break.
    • Extra - will show notification 60 seconds before the break starts, and 30s before the break ends, and the actual break starts.

  • Special breaks - a special feature that enables you to set specific times to take important breaks like lunch, snack, dinner and etc.. without updating the Pomodoro configuration.

  • Keyboard shortcuts - might be helpful for you depending on your use case but currently, these keyboard shortcuts are not yet customizable.

  • Auto updates - the app will automatically check for updates and download them in the background. You will be notified when the update is ready to be installed.

  • Always on top - once enabled, the app will always be on top of other apps running on your Operating System.

  • Minimize to tray - once enabled, the minimize action will not minimize the app. Instead, it will be hidden and sent to the tray.

  • Close to tray - once enabled, the close action will not quit the app. Instead, it will be hidden and sent to the tray.

  • Progress on tray - the app will show a progress indicator on your system tray. This feature can be activated if minimize to tray or close to tray feature is enabled also.

  • Progress animation - by default, you will get a smooth timer progress animation but if you're worried about the app's memory consumption on your computer, you can disable it by the way.

  • Toggle native titlebar - it allows you to switch between the custom title bar of the app to a native one provided by your Operating System and vice versa, depending on your personal preference.

  • Auto-start work time - once enabled, you will no longer need to manually start the work timer again after the break ends, it will automatically start for you.

  • Voice assistance - once enabled, your desktop notification will include a male voice to inform you of things related to your Pomodoro session. Useful sometimes especially when you're away from your computer during break time.

  • Dark theme - it allows you to use dark mode and helps you reduce eye strain and improves visibility if you are the type of person with low vision and high sensitivity to bright light.

  • Strict mode - once enabled, the app will strictly follow the rules you have set and prevent you from pausing, skipping, and resetting the timer when it started.

  • Compact Mode - once enabled, the app will occupy less space on your screen and it will be useful if you're using a small-screen device.

⚡ Quick Setup

📃 Prerequisites

  1. You need to have node v18 and npm v8 installed on your machine. If you don't have it yet, you can install it by running the following command.

    1. For Mac

      brew install node

    2. For Windows

      choco install nodejs

    3. For Linux

      sudo apt install nodejs

    4. Using Node Version Manager (Recommended)

      # Inside the project directory
nvm install && nvm use

      To automatically switch to the correct node version when you enter the project directory, just follow the details here.

    Or you can download it from here.

  2. You need to have yarn globally installed on your machine. If you don't have it yet, you can install it by running the following command.

    1. For Mac

      brew install yarn

    2. For Windows

      choco install yarn

    3. For Linux

      sudo apt install yarn

    4. Using npm

      npm install -g yarn

📦 Installation

  1. Install all app dependencies.

    yarn install

  2. Start the development.

    yarn dev:app

🛠 Building for Production

  1. Build Windows installer.

    yarn build:win

  2. Build macOS installer.

    yarn build:mac

  3. Build Linux installer.

    yarn build:linux

  4. Build macOS, Windows and Linux installer at once.

    yarn build:mwl

📝 Pre-Commit

If your pr is being rejected due to the pre-commit checks, just download pre-commit using pip install pre-commit or via one of the commands here. Once that is installed just running pre-commit should automatically fix the files.

💻 Installation

Available for Windows, macOS, and Linux.

Download the latest version from the Releases Page or from the 👉 Download Page .

For Linux users:

If you want to be always updated with the latest release, recommended way to install it is via Snap Store.

Get it from the Snap Store

Please consider starring this project to show your 💙 and support. Thank you so much 🙇‍♂️

📰 License

MIT © Roldan Montilla Jr