https://github.com/tomasesquivelgc/pomodoro-clock

⏰📝"Pomodoro Clock" is a simple web app that helps you study using the Pomodoro method, in which you set intervals for study and breaks (25+5). How useful!
https://github.com/tomasesquivelgc/pomodoro-clock

freecodecamp-project javascript javascript-library pomodoro-timer reactjs

Last synced: 7 days ago
JSON representation

⏰📝"Pomodoro Clock" is a simple web app that helps you study using the Pomodoro method, in which you set intervals for study and breaks (25+5). How useful!

• Host: GitHub
• URL: https://github.com/tomasesquivelgc/pomodoro-clock
• Owner: tomasesquivelgc
• Created: 2023-07-15T20:44:19.000Z (over 1 year ago)
• Default Branch: development
• Last Pushed: 2024-03-18T20:13:47.000Z (8 months ago)
• Last Synced: 2024-10-16T07:05:33.588Z (22 days ago)
• Topics: freecodecamp-project, javascript, javascript-library, pomodoro-timer, reactjs
• Language: JavaScript
• Homepage: https://fabulous-sherbet-db83da.netlify.app
• Size: 101 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  
Pomodoro Clock




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Pomodoro clock 

**Pomodoro Clock** is a simple project that aims to clone [FreeCodeCamp's version](https://25--5-clock.freecodecamp.rocks). To do this, I have built a page using React (Vite) and added some CSS to resemble the template. You can run the FCC test suite directly from the live demo!

## 🛠 Built With 

### Tech Stack 

  libraries

  


    
React.js

    
Vite

  

  Languages

  


    
CSS

    
Javascript

    
HTML

  


### Key Features 

- **Stopwatch funtionality with study and break timers**

- **changeable times using buttons**

(back to top)


## 🚀 Live Demo 

visit [this link](https://fabulous-sherbet-db83da.netlify.app) for a live demo!

(back to top)


## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need a browser.

### Setup

Clone this repository to your desired folder:

Example commands:

```sh

  cd my-folder

  git clone [email protected]:myaccount/my-project.git

```

### Install

Install this project with:

Example command:

```sh

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

### Run tests

To run tests, click on the hamburger button and select "Markdown previewer" (note: these are the tests that FreeCodeCamp include.).

## 👥 Authors 

👤 **Tomás Esquivel**

- GitHub: [@tomasesquivelgc](https://github.com/tomasesquivelgc)

(back to top)


## 🔭 Future Features 

- [] **Icons replacing unaesthetic buttons**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project give it a star.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse and my friends and family for their support.

(back to top)