Pomodoro

Minimalistic web-based pomodoro timer

🚩 Table of Contents

• ❓ What is it?
• 📋 Roadmap
• 💬 Contributing
  • 🔌 Scripts
  • 🧰 Prerequisites
  • 🔧 Setup
  • 💻 Running a development server

❓ What is it?

A clean web-based timer using the pomodoro technique. The project was created due to a lack of a web-based timer using the pomodoro technique with a robust feature set.

If you have any questions or would like to talk about the project feel free to start a discussion.

📋 Roadmap

Feature	State?
Themes	✅ Completed
Adjust Period Order (Drag and Drop)	✅ Completed
Add Period	✅ Completed
Delete Period	✅ Completed
UI Audio	⚠️ Partially
Complete Storybook Coverage	❌ On Roadmap
PWA	❌ On Roadmap
Custom Themes	❌ On Roadmap
Add Custom Period	❌ On Roadmap
Change Period Title/Duration	❌ On Roadmap
P2P Device Sync	❌ On Roadmap

💬 Contributing

I would extremely appreciate any contributions to the project! Please refer to the CONTRIBUTING.md file, CODE_OF_CONDUCT.md file, roadmap, and the existing issues before getting started.

🔌 Scripts

Any of the following scripts can be run from the terminal using the following format:

npm run SCRIPT_NAME

Name	Description
dev	Runs all dev:** scripts simultaneously
dev:netlify	Runs a dev server with the netlify cli
dev:storybook	Runs a storybook dev server
build	Builds the production-ready version of the site
build:storybook	Exports a static version of storybook

🧰 Prerequisites

• This project uses React, please make sure you have at least a fundamental understanding of React before contributing.
• In addition to React this project uses Next.js. It is also recommended to have some knowledge of Next.js before contributing. Please use the following links as reference for Next.js:
  • Next.js Documentation - learn about Next.js features and API.
  • Learn Next.js - an interactive Next.js tutorial. d

🔧 Setup

1. Install Node.js (Please make sure you install node version 10 or greater).

2. Clone this repository to your computer and navigate to the project's root directory.

3. Run the following command to install all required node packages:

   npm i

💻 Running a development server

1. If you haven't already, follow the setup instructions before continuing.

2. Run a development server using the following command (Reference the scripts for a full list of all scripts):

   npm run dev:netlify

3. A browser tab will be opened automatically pointing to http://localhost:8888.