🌟 cuchi-pomodoro

A simple yet effective Pomodoro timer designed to boost productivity using the famous Pomodoro technique. Work smarter by breaking your tasks into manageable chunks with regular breaks.

---

📋 About the Project

Cuchi-Pomodoro is a lightweight, easy-to-use timer tool that helps users stay focused and productive. The Pomodoro technique divides work into short, focused sessions (typically 25 minutes) followed by short breaks, making tasks feel more achievable and helping to reduce burnout.

This project is built with Vue.js.

---

🚀 Features

• 🔥 Work/Break Sessions: Default 25-minute focus.
• ⏲️ Easy to Use: Minimal interface for quick setup and use.
• 📈 Productivity Booster: Stay on track with the Pomodoro method.
• 🧪 Unit Tested: Ensures reliability with tests using Vitest.

---

🛠️ Project Setup

Make sure you have Node.js installed on your machine before proceeding.

1. Fork the Repository

2. Clone the Repository

   git clone https://github.com/<your-username>/cuchi-pomodoro.git

   cd cuchi-pomodoro

3. Install Dependencies

   npm install

---

👨‍💻 Development

To start the development server with hot-reloading (reflects changes instantly):

npm run dev

The app will be available at http://localhost:3000 by default (or whichever port is assigned).
here port:5173 is assigned.

---

🏗️ Production Build

For production, compile and minify the project:

npm run build

The compiled assets will be available in the /dist folder, ready to be deployed.

---

🧪 Testing

Run unit tests to ensure the app works as expected:

npm run test:unit

Testing is powered by Vitest, a fast testing framework for modern JavaScript.

---

🧹 Code Quality

Run ESLint to analyze and format your code for consistent style and to catch common issues:

npm run lint

---

🤝 Contributing

Feel free to contribute to this project by reporting issues, suggesting new features, or submitting pull requests.

After setting up the project locally:

1. Create a new branch for your changes:

   git checkout -b your-feature-branch

2. Commit your changes:

   git add .

   git commit -m "Describe your changes"

3. Push your code to your branch:

   git push origin your-feature-branch

4. Create a Pull Request (PR) from your branch to the main repository.

---

• Inspired by the Pomodoro Technique created by Francesco Cirillo.