https://github.com/bfukumori/ignite-timer
Timer for Pomodoro technique
https://github.com/bfukumori/ignite-timer
ignite-rocketseat immer react react-router-dom reacthookform styled-components typescript vite zod
Last synced: 8 months ago
JSON representation
Timer for Pomodoro technique
- Host: GitHub
- URL: https://github.com/bfukumori/ignite-timer
- Owner: bfukumori
- License: mit
- Created: 2022-07-10T04:29:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-26T03:29:29.000Z (over 2 years ago)
- Last Synced: 2023-03-04T20:48:47.701Z (over 2 years ago)
- Topics: ignite-rocketseat, immer, react, react-router-dom, reacthookform, styled-components, typescript, vite, zod
- Language: TypeScript
- Homepage: https://ignite-timer-rho.vercel.app/#/
- Size: 485 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![]()
About •
Features •
How it works •
Tech Stack •
Author •
License
![]()
![]()
## About
⏳ ignite-timer - Counter to use with Pomodoro technique.
Project developed during the ReactJS Ignite Course from [Rocketseat](https://www.rocketseat.com.br/ignite).
---
## Features
- [x] Create a timer
- [x] Interrupt timer
- [x] Log timer history
- [x] Persist data in local storage---
## How it works
### Pre-requisites
Before you begin, you will need to have the following tools installed on your machine:
[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).
In addition, it is good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/)#### Running the web application (Frontend)
```bash
# Clone this repository
$ git clone [email protected]:bfukumori/ignite-timer.git# Access the project folder in your terminal
$ cd ignite-timer# Install the dependencies
$ npm install# Run the application in development mode
$ npm run dev# The app will open on the port: 3000 - go to http://localhost:3000/
```
---
## Tech Stack
The following tools were used in the construction of the project:
#### **Website** ([React](https://reactjs.org/) + [TypeScript](https://www.typescriptlang.org/))
- **[PhosphorIcons](https://phosphoricons.com/)**
- **[date-fns](https://date-fns.org/)**
- **[Vite](https://vitejs.dev/)**
- **[React Router](https://v5.reactrouter.com/web/guides/quick-start)**
- **[Immer](https://immerjs.github.io/immer/)**
- **[Styled Components](https://styled-components.com/)**
- **[Zod](https://zod.dev/)**
- **[React Hook Form](https://react-hook-form.com/)**---
## Author[](https://twitter.com/hi_fukujp) [](https://www.linkedin.com/in/bfukumori/)
[](mailto:[email protected])---
## License
This project is under the license [MIT](./LICENSE).
---