Skip to content

A minimalist Pomodoro Timer, designed with Notion in mind. Perfect for embedding into your Notion workspace, featuring all essential Pomodoro functionalities to boost your productivity!

License

Notifications You must be signed in to change notification settings

sameetpatil5/notion-pomodoro-timer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notion Pomodoro Timer

License: Modified MIT Status: In Development

Notion Pomodoro Timer is an open-source repository for the development of a minimalist Pomodoro timer, designed to function as a simple Notion widget. Its goal is to provide quick and easy integration of a productivity timer within Notion.


✨ Features

  1. Adjustable Timer Durations:

    • Customize focus, short break, and long break times.
  2. Customizable Design:

    • Change background colors, text colors, and fonts for a personalized look.
  3. Configurable Sessions

    • Save your custom configurations for one-click session setup.
  4. Lightweight and Simple:

    • Uses only HTML, CSS, and JavaScript for fast loading and minimal resource usage.

🚧 Development Status

This project is currently under development and does not represent the final product.

Note: The expected features and designs are subject to change as the project progresses.


🚀 Deployment

Deploying the Website

The widget/ webpage is deployed on GitHub Pages.

Embedding into Notion

  1. Go to your Notion page.

  2. Use the /embed command in Notion and paste the GitHub Pages link:

    https://sameetpatil5.github.io/notion-pomodoro-timer/
    

Workflow for Updates

When you make changes in main and want to test them

  1. Merge main into staging to test:

    # Switch to the 'staging' branch
    git checkout staging
    
    # Merge changes from 'main' into 'staging'
    git merge main
    
    # Push the updates to the remote repository
    git push
  2. After testing, merge staging into deploy to deploy:

    # Switch to the 'deploy' branch
    git checkout deploy
    
    # Merge changes from 'staging' into 'deploy'
    git merge staging
    
    # Push the updates to the remote repository
    git push

Reverting if Something Breaks

If something breaks in deploy, you can revert to the last working state using:

git checkout deploy
git reset --hard <last-working-commit-hash>
git push --force origin deploy

📂 File Structure

notion-pomodoro-timer/
├── index.html      # Main HTML file for the Pomodoro timer
├── styles.css      # CSS file for styling
├── script.js       # JavaScript file for functionality
├── README.md       # Project documentation and Announcements
└── LICENSE         # Project License

🛡️ License

This project is licensed under the MIT License.


📢 Contributions

Contributions are welcome!

  1. Fork this repository.

  2. Create a new branch:

    git checkout -b feature-branch-name
  3. Make your changes and commit them:

    git commit -m "Description of changes"
  4. Push your branch:

    git push origin feature-branch-name
  5. Submit a pull request.


💬 Contact

For questions or feedback, please open an issue in the repository.


Thankyou for visiting this Repository

Special thanks to @Giorgiark, whose GitHub repository Giorgiark/pomodorotimer provided the initial inspiration for this project.

About

A minimalist Pomodoro Timer, designed with Notion in mind. Perfect for embedding into your Notion workspace, featuring all essential Pomodoro functionalities to boost your productivity!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published