Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.22 KB

README.md

File metadata and controls

85 lines (57 loc) · 3.22 KB
Raw

Pomodoro

Warning This app is a work in progress.

About this project

Welcome to our open-source Pomodoro app! This project is licensed under the MIT License and is developed using Angular 16.2.2 with an ESLint configuration.

Features

Our Pomodoro app comes with a variety of features to help users manage their time effectively, including:

Nothing for the moment

Roadmap

We're continuously improving our Pomodoro app to provide you with the best time management experience. Here's what we're working on:

Priority | Feature

  • Pomodoro Timer: Set work intervals and breaks to enhance productivity.
  • Customizable Settings: Personalize timer duration, notification sounds, and more.
  • Task Management: Organize tasks and track progress within the app.
  • Intuitive Interface: User-friendly design for a seamless experience.
  • Data Visualization: Analyze productivity patterns with insightful charts and graphs.

Non-priority | Feature

  • Integration with Task Management Tools: Sync tasks with popular apps like Trello, Asana, and Todoist.
  • Collaboration Features: Share timers and tasks with team members for enhanced teamwork.
  • Mobile Apps: Access the Pomodoro app on your iOS and Android devices.
  • Advanced Analytics: Dive deeper into productivity data with advanced reporting tools.
  • Integration with Calendar Apps: Plan Pomodoro sessions around your schedule seamlessly.

Known issues

  • No logo :(

Running locally

To run the Pomodoro app locally on your machine, follow these steps:

  1. Clone the repository: git clone https://github.com/RomainAntunes/pomodoro.git
  2. Navigate to the project directory: cd pomodoro
  3. Install dependencies: npm install
  4. Start the development server: ng serve
  5. Open your browser and visit http://localhost:4200 to access the app.

Contributing

Feel free to contribute to our Pomodoro app and make time management a breeze for users worldwide! If you have any questions or suggestions, please open an issue or reach out to us. Happy Pomodoro-ing! 🍅🕒

Using Semantic Commit Messages for Contributions

We encourage contributors to follow the semantic commit message convention when making changes to the project. Semantic commits help maintain a clear and organized commit history, making it easier to track changes and understand their impact.

When contributing to this project, please adhere to the following guidelines for commit messages:

  • feat: for new features or significant changes.
  • fix: for bug fixes.
  • docs: for documentation updates.
  • style: for code style changes (e.g., formatting).
  • refactor: for code refactoring without adding new features or fixing bugs.
  • test: for adding or updating tests.
  • chore: for routine tasks, maintenance, or tooling changes.

Example commit messages:

  • feat: add new task management feature
  • fix: resolve issue with timer not resetting
  • docs: update README with installation instructions

Using semantic commit messages ensures that our project's version history is meaningful and understandable. Thank you for your contributions and helping us maintain a clean commit history!

License

Licensed under the MIT License.