Skip to content

Latest commit

 

History

History
314 lines (261 loc) · 13.2 KB

README.md

File metadata and controls

314 lines (261 loc) · 13.2 KB

lang-en lang-pt-br

Ignite Timer logo

Ignite Timer

Repository language count Repository size Commit activity Last commit Project license Layout designer

Screenshot of the application initial page

Go to the web application ↗

📒 Table of Contents

📍 Overview

This project is a web application developed in React and TypeScript that serves as a timer tool for managing cycles. It allows users to create cycles with specific tasks and durations, interrupt cycles, and mark them as finished.

The application offers features such as countdown timers, history and an easy-to-use interface, improving productivity and time management skills.

✨ Features

⏱ Define what you want to work on, and how long for

🎯 Change browser tab and keep watching the time go by

🔄 Refresh the page doesn't lose progress

📃 View ongoing, completed and/or interrupted tasks in a history format

🤖 Demo

ignite-timer.mp4

🎨 Layout

The layout of the application was designed by Rocketseat and is available on Figma.

Web application layout image cover

🛠 Technologies

The following tools were used to build the project:

Website

Vite React TypeScript ESLint Rocketseat ESLint config

React Router React Hook Form Zod date-fns Immer

styled-components Phosphor Icons

* See the package.json file

Utils

Git Node.js Figma Google Fonts VSCode

🚀 Getting Started

✔️ Prerequisites

Before you begin, ensure that you have the following tools installed on your machine: Git, Node.js. It's also good to have an editor to work with the code, such as VSCode.

📦 Installation

  1. Clone the repository:
git clone https://github.com/guipmdev/ignite-timer/
  1. Change to the project directory:
cd ignite-timer
  1. Install the dependencies:
npm install

⚙️ Usage

  1. Start the web application:
npm run dev
  1. Access https://localhost:5173/ to view the application

📄 License

This project is licensed under the terms of the MIT license. See the LICENSE file for additional info.

👏 Acknowledgments

  • Many thanks to Rocketseat for the layout and tips when putting this project together

Made with 💙 by @guipm.dev - Feel free to contact me!


↑   Return to the top   ↑