Skip to content

Mafifa/Maff-pomodoro

Repository files navigation

Mafifa Pomodoro

Version License

A desktop application designed to boost your productivity using the Pomodoro Technique.

🚀 Overview

Mafifa Pomodoro is the perfect tool for those looking to enhance focus, improve productivity, and minimize distractions in their daily tasks. It features a unique Intangible Mode for distraction-free work sessions.

🌟 Key Features

  • Intuitive Time Management: Break your work into 25-minute intervals (Pomodoros) separated by short breaks, optimizing your focus and energy.
  • Intangible Mode: Activate this special mode with Ctrl + 6 to make the application window temporarily disappear while still running in the background, eliminating visual distractions.
  • Cross-platform Compatibility: Available for Windows, macOS, and Linux.
  • Minimalist Modern Interface: Designed with React and TailwindCSS for a pleasant and simple visual experience.
  • Lightweight and Efficient: Built with Electron, consuming minimal system resources.

🛠 Installation

Follow these steps to set up Mafifa Pomodoro on your device:

  1. Install Node.js (version 18 or higher, if not already installed).
  2. Clone the repository:
    git clone https://github.com/your-username/mafifa-pomodoro.git
    cd mafifa-pomodoro

3. **Install dependencies**:

```shellscript
npm install
  1. Run the application in development mode:
npm run dev
  1. Build the application for your operating system:

  2. Windows:

npm run build:win
  1. macOS:
npm run build:mac
  1. Linux:
npm run build:linux

🌫 Using Intangible Mode

The Intangible Mode is perfect for those who want to concentrate without the application window visible while keeping the functionality active in the background.

  • How to activate: Press Ctrl + 6 while the application is open.

  • What happens:

  • The window temporarily hides, but the timer continues running.

  • You can focus completely on your task without visual interruptions.

  • How to deactivate: Press Ctrl + 6 again to restore the window.

🔧 Technologies Used

  • Electron: For creating the desktop application.
  • React and TailwindCSS: For the user interface.
  • TypeScript: For typed and robust development.
  • Electron-Vite: For a fast and efficient development environment.

⚠️ Limitations

  1. Manual Configuration: The application requires users to have basic programming knowledge for correct installation and configuration.
  2. No Predefined Advanced Settings: While the system is functional, advanced users may need to customize some aspects of the code to adapt it to their needs.

🤝 Contributions

All contributions are welcome! If you find a bug or want to suggest improvements, please create an issue or submit a pull request in the repository.

📄 License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.


What's Included in This README?

  1. Clear Purpose Description: Explains what the application is and what it's used for.
  2. Key Features: Highlights the Intangible Mode and the application's advantages.
  3. Installation and Usage Guide: Step-by-step instructions for setup.
  4. Specific Use of Intangible Mode: Detailed explanation for users to understand how it works.
  5. Limitations: Clarifies that it's not an out-of-the-box solution.
  6. Additional Information: Includes licensing and suggestions for contributions.

About

Pomodoro para gestionar tu tiempo de trabajo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published