Home

Awesome

<p align="center"> <a href="https://zidoro.github.io/pomatez/"> <img src=".github/assets/logo.png" alt="Pomatez logo" width="56" height="56"> </a> </p> <h1 align="center">Pomatez</h1> <h3 align="center">Stay Focused. Take a Break.</h3> <p align="center"> <br> <a href="#sparkles-features">Features</a> . <a href="https://discord.gg/ZqPqN3hwcB" target="_blank">Discord</a> . <a href="#call_me_hand-development">Development</a> . <a href="#computer-installation">Installation</a> . <a href="#shield-privacy">Privacy</a> . <a href="#newspaper-license">License</a> <br> <br> </p> <p align="center"> <a href="https://snapcraft.io/pomatez"> <image src="https://snapcraft.io/pomatez/badge.svg" alt="Pomatez" /> </a> <image src="https://img.shields.io/github/downloads/zidoro/pomatez/total" alt="Github Downloads" /> <a href="https://github.com/zidoro/pomatez/releases/latest"> <image src="https://img.shields.io/github/v/release/zidoro/pomatez" alt="Latest Version" /> </a> <a href="https://github.com/zidoro/pomatez/blob/master/LICENSE"> <image src="https://img.shields.io/github/license/zidoro/pomatez" alt="License" /> </a> </p>

App Preview

:sparkles: Features

:zap: Quick Setup

:page_with_curl: 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
      

:package: 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
    

:pencil: 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.

:computer: Installation

Available for Windows, macOS, and Linux.

Download the latest version from the Releases Page or from the :point_right: 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 :blue_heart: and support. Thank you so much :bowing_man:

:newspaper: License

MIT © Roldan Montilla Jr