25 + 5 Clock - README

Table of Contents

• Introduction
• Demo
• Features
• Technologies
• Installation
• Usage

Introduction

Welcome to the 25 + 5 Clock project! This is a web application that allows users to set and manage their work and break times using the Pomodoro technique. The Pomodoro technique is a time management method that uses a timer to break down work into intervals, traditionally 25 minutes in length, separated by short breaks.

This project was built as part of the FreeCodeCamp Front End Libraries Certification. It fulfils a set of user stories designed to test various aspects of the application, ensuring it meets functional requirements and usability standards.

Demo

You can access the live demo of this project at https://3pn73q.csb.app/.

Features

The 25 + 5 Clock project includes the following features:

1. Session and Break Length Control: Users can increase or decrease the session and break lengths.

2. Timer Display: The app displays the session timer in mm:ss format.

3. Start/Stop Timer: Users can start or stop the timer.

4. Reset: Users can reset the timer and session/break lengths to their defaults.

5. Audio Alert: When the timer reaches 00:00, an audio alert plays.

6. Timer Label: The timer label updates to indicate whether it's a session or a break.

7. Pause/Resume: Users can pause and resume the timer.

Technologies

The project was built using the following technologies and libraries:

• React
• JavaScript
• HTML
• CSS

Installation

To run this project locally, follow these steps:

1. Clone the GitHub repository:

   git clone https://github.com/abhisheksharma1310/25-5-clock.git

2. Navigate to the project directory:

   cd 25-5-clock

3. Install the project dependencies:

   npm install

4. Start the development server:

   npm start

The application will be accessible in your web browser at http://localhost:3000.

Usage

1. Session and Break Length Adjustment: Use the ⬆️ and ⬇️ buttons to adjust the session and break lengths as desired. The timer will update accordingly.

2. Start/Stop Timer: Click the "Start/Stop" button to begin or pause the timer.

3. Reset: Click the "Reset" button to reset the timer and session/break lengths to their default values.

4. Audio Alert: When the timer reaches 00:00, an audio alert will play.

---

This project is a solution for the FreeCodeCamp "Build a 25 + 5 Clock" project.