A open source pomodoro timer made for everyone!

See live! 😁

Index

• 🚀 Project Summary
• 👨‍💻️ Technologies Used
• 📦️ How to install the project
• 🤔️ How can you contribute?
• 🎨 Prototype
• 🔮 Future Improvements

---

🚀 Project Summary

Pomoo is made for everyone, a simple and minimalist pomodoro timer created to help you in your daily and small tasks!

---

👨‍💻️ Technologies Used

This project was developed using the technologies bellow:

Website

• Next.js

Dependencies

Website

• React Icons
• Styled components
• Typescript

Code patterns

• ESLint
• Prettier

IDE

• Visual Studio Code

---

📦️ How to install the project

Node.js and Yarn or NPM are required

To clone the project, use the commands bellow:

  # Clone the repository
  ❯ git clone https://github.com/MathPSantos/Ecoleta.git

  # Enter directory
  ❯ cd Pomoo

Web

To install dependencies and initialize the project, you can use Yarn or NPM:

Using yarn

  # Enter web directory
  > cd web

  # Install the dependencies
  ❯ yarn

  # Start the project
  ❯ yarn start

Using npm

If you use NPM, delete yarn.lock file to see all installed dependencies in the best way.

  # Enter web directory
  > cd web
  
  # Install the dependencies
  ❯ npm install

  # Start the project
  ❯ npm start

---

🎨 Prototype

Pomooo prototype was made at figma and you can see in this link!

---

🤔️ How can you contribute?

1. fork this repository
2. Create a branch with your feature:
   • $ git checkout -b my_feature
3. Commit your branch:
   • $ git commit -m "feature: My new feature"
4. Submit your branch:
   • $ git push origin my_feature

---

🔮 Future Improvements

Web

• Finish Tasks feature
• Add settings feature
• Add Donate feature
• Work on website SEO

---

License

MIT License

Made with ❤️ by Matheus Pires Santos! Get in touch or send a email to [email protected]!