Skip to content

huanamigo/pomodoro-web-app

Repository files navigation

Pomodoro Timer Web App

Description

The Pomodoro Timer Web App is a simple yet effective productivity tool built using TypeScript and Vite. It utilizes the Pomodoro Technique, which involves alternating work sessions with short breaks to maximize focus and efficiency. This application is designed to help users manage their work intervals and break periods with ease.

Features

Configurable Timer: Set the duration for work sessions and short/long breaks. Responsive Design: Compatible with desktop and mobile devices.

Technologies

  • TypeScript: For safe and scalable JavaScript code.
  • Vite: A modern frontend build tool that provides faster and leaner development experience.
  • React: For building the user interface with reusable UI components.

Project Setup

Prerequisites

Ensure you have Node.js installed on your machine. This project was built using Node.js v20.10.0

Installation

  1. Clone the repository:
git clone https://github.com/huanamigo/pomodoro-web-app.git
cd pomodoro-web-app
  1. Install dependencies:
npm i
  1. Start the development server:
npm run dev

The application will be available at http://localhost:5173.

Building for production

To build the application for production, run:

npm run build

This command generates static assets in the dist directory that can be served over any static file server.

Usage

After starting the app, you can:

Set the duration of Pomodoro sessions and breaks via the settings panel. Start, pause, or reset the timer as needed. View your daily Pomodoro session count on the history page.

Contributing

Contributions to the Pomodoro Timer Web App are welcome! If you would like to contribute, please follow these steps:

  • Fork the repository.
  • Create a new branch for your feature (git checkout -b feature/AmazingFeature).
  • Commit your changes (git commit -m 'Add some AmazingFeature').
  • Push to the branch (git push origin feature/AmazingFeature).
  • Open a pull request

Releases

No releases published

Packages

 
 
 

Contributors