README.md

Pomodoro Timer

About the project   |    Getting started   |    How to contribute      

👨🏻‍💻 About the project

• The pomodoro technique is used to improve focus and productivity by dividing work into focus sessions and breaks. I performed the Pomodoro implementation in an app made in React and Typescript using Nextjs.

💻 Getting started

Clone the project and access the folder

$ git clone https://github.com/franmoraiiss/pomodoro-timer.git && cd pomodoro-timer

First, install the necessary dependencies by running:

npm install
# or
yarn

Then, start the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying /src/pages/index.tsx. The page auto-updates as you edit the file.

All components are distributed in the folder /src/components.

The logic behind the counter is inside /src/contexts/CountdownContext.tsx

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork franmoraiiss/pomodoro-timer

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd pomodoro-timer

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

---

✍️ Authors

• Francisco Morais

  Thanks for your visit! Have a nice day :)

Made with 💜