Giter VIP home page Giter VIP logo

pomoquest's Introduction

Pomoquest - Gamified Pomodoro Timer

Pomoquest is a production-ready, gamified pomodoro timer designed to enhance productivity. It incorporates the popular pomodoro technique, where work intervals are followed by short breaks, to help users maintain focus and manage their time effectively. The app rewards users with coins upon completion of each timer, which can be utilized to enhance the in-app experience.

Trello Board

trello board for this project

Screenshots

image image

Mobile

image image image[ image

Why use Pomoquest?

  • Gamify your productivity: Earn coins based on the successful completion of any timer (1 coin per minute).
  • Customizable Background Colors: Utilize the earned coins to unlock new background colors for the site, allowing you to customize your Pomodoro Timer experience.
  • It just looks better than other timers. Modern, responsive UI.
  • Custom Timers: Personalize your focus/break time according to your preferences.
  • Upcoming Features: PomoQuest has exciting features planned for the future, including more custom settings, the ability to change the alarm sound, and productivity report charts.

Key Features

  • Pomodoro Timer: Pomoquest offers a fully functional pomodoro timer with customizable work and break durations. Users can easily start, pause, and reset the timer according to their workflow requirements.
  • Gamification: The app implements a gamification aspect, providing users with coins as a reward for completing timers. This feature adds an element of fun and motivation to the productivity journey.
  • Coin System: Users accumulate coins based on their timer completion. These coins can be spent within the app to unlock various enhancements and improvements, contributing to an improved user experience.
  • In-App Enhancements: Pomoquest offers a range of upgrades and improvements that can be purchased using the accumulated coins. These enhancements may include additional features, customizable themes, or advanced productivity tools.
  • Deployment: PomoQuest is deployed on the Vercel platform, ensuring reliable and scalable hosting. The data is stored on PlanetScale, providing a robust and efficient database solution.

Getting Started

To get started with PomoQuest, follow these steps:

  1. Clone the repository: git clone https://github.com/your-username/pomoquest.git
  2. Install the necessary dependencies: npm install
  3. Configure the environment variables required for Vercel and PlanetScale integration.
  4. Build and start the application: npm run start
  5. Access the app in your browser at http://localhost:3000.

Dependencies

Pomoquest utilizes the following key dependencies:

  • React: JavaScript library for building user interfaces.
  • TypeScript/tRPC: Type Safety across the entire stack.
  • Vercel: Cloud platform for hosting and deploying web applications.
  • PlanetScale: Database management system for efficient and scalable data storage.
  • Prisma: ORM to prevent SQL injections.
  • Clerk: 3rd party Authentication/User Management services.

Contribution

Contributions to PomoQuest are always welcome! To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure they are properly tested.
  4. Commit and push your changes to your forked repository.
  5. Open a pull request, providing a detailed description of your changes.

Please ensure that your contributions adhere to the code standards and guidelines defined in the project.

License

MIT License

Contact

For any inquiries or feedback, please reach out to me at [email protected].

pomoquest's People

Contributors

kevinleaves avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.