Skip to content

JoeDareZone/pomodoro-joe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Issues MIT License LinkedIn


Logo

Pomodoro Joe

A simple React app to help with self-study.
Integrating a Todo List, Pomodoro Timer and a Lofi Soundcloud Widget.


Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Product Name Screen Shot

This Pomodoro Timer app is designed to help with studying, coding, or any other tasks you would like to separate into small chunks.

For information on Pomodoro timers, please refer to https://en.wikipedia.org/wiki/Pomodoro_Technique

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/joewhocodes/pomodoro-joe.git
  2. Install NPM packages
    npm install

(back to top)

Usage

Click "Set Some Tasks" to set your Todos for your Pomodoro. The page will remember your Todos when you refresh or come back to the page later.

The Pomodoro timer will automatically move onto a 5 minute break when you have completed 25 minutes. It will then move onto a 20 minute break after 4 Pomodoros.

Feel free to pause or reset the timer as you please.

For information on Pomodoro timers, please refer to https://en.wikipedia.org/wiki/Pomodoro_Technique

(back to top)

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

Joe Ulyatt - @joewhocodes - joewhocodes@gmail.com

Project Link: https://github.com/joewhocodes/pomodoro-joe

(back to top)

About

A small React app, to help with self-study.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages