/pomodoro-timer

A pomodoro timer in plain JS

Primary LanguageJavaScriptMIT LicenseMIT

Forks Stargazers Issues MIT License


Pomodoro Timer JS

Challenge #1 for the Advent of JavaScript


View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  3. Installation
  4. Usage
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About The Project

A simple Pomodoro Timer in plain JS

(back to top)

Getting Started

Installation

git clone https://github.com/voiceinthedark/pomodoro-timer.git
cd pomodoro-timer
code .

(back to top)

Usage

Clicking on the tools button will allow the user to change the required time limit.

(back to top)

Roadmap

  • Add feature of local browser save, when the user sets the time limit.
  • Add a sfx sound when the timer approaches ending
  • Add ambient zen music playing in the background while the timer is running
  • move the music bar into it's own retractable drawer
  • Make an infinie playlist and single song loop

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Email: DarkRisingForce@Gmail.com

Project Link: https://github.com/voiceinthedark/pomodoro-timer

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)