GitHub Streaker

GitHub Streaker is a customizable tool designed to help developers and users create and visualize a streak calendar, similar to GitHub's contribution graph, with added features to track their progress toward unique goals.

Source: GitHub User profile page with 0 contribution

Source: GitHub User profile page with high contribution

Source: GitHub Streaker with custom contribution

Features

Current Features

• Custom Streak Calendar: Users can create a layout on the calendar, mirroring GitHub’s contribution graph, and generate a corresponding to-do list with tasks and dates to guide them toward achieving the pattern.
• Contribution Goal: Set a target number of contributions and visualize your progress with a dynamic progress bar.
• Custom Colors: Change streak cell colors to enhance visual appeal. Each theme can have a unique color palette.
• Todo List Generator: Automatically generate tasks based on your custom streak pattern. Downloadable as a checklist to help track your progress.
• Shareable Links: Share your custom streak calendar with others using a unique URL (e.g., https://abinbn.github.io/Github_Streaker/?grid=000004...).

Upcoming Features

• GitHub Sync: Synchronize with GitHub to track how your actual contributions compare to your planned streak and goals.
• Text to Calendar: Convert text into pixelated characters on the streak calendar. The tool will generate tasks to help you achieve the desired text pattern (e.g., a name or message).
• Shape Printing: Easily add predefined shapes or patterns to the calendar.
• Streak Removal: Use Ctrl + Left Click to quickly remove contributions from individual cells.

Demo

Try out the current version of the GitHub Streaker tool here.

Installation

1. Clone the repository:

   git clone https://github.com/Abinbn/Github_Streaker.git

2. Navigate to the project directory:

   cd Github_Streaker

3. Open index.html in your browser to start using the app.

How It Works

• Create a Custom Streak: Click on the grid to fill cells with contribution levels and generate your unique streak pattern.
• View Todo List: The app generates a corresponding to-do list to help you complete the streak. Tasks are tied to specific days and include suggestions to keep your contributions meaningful.
• Track Your Progress: As you complete tasks, you can manually strike them off the list and visualize your progress with the progress bar.
• Download Your Todo List: You can download your generated list as a checklist for tracking your progress offline.

Controls

• Navigate Calendar: Use the "Previous Year" and "Next Year" buttons to view and edit contributions from past or future years.
• Randomize: Generate a random streak pattern for inspiration or testing.
• Reset Grid: Clear the entire calendar grid to start fresh.
• Sync with GitHub: (Upcoming) Automatically sync with your GitHub contributions to track your real progress against your custom streak.

Contributions and Collaboration

We welcome contributions and collaborations! You can get involved by submitting new features, fixing bugs, or enhancing existing functionality. To contribute:

1. Fork the repository.
2. Create a new branch: git checkout -b feature-branch-name.
3. Commit your changes: git commit -m 'Add new feature'.
4. Push to your branch: git push origin feature-branch-name.
5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Version 2

Many new features have been added to this version of GitHub Streaker:

• Instead Remover: Hold the Ctrl key and select a cell to remove the input in that cell.
• Timelapse: An animated feature to view your calendar creation, allowing you to visualize how it looks.
• Compare Between Versions: The first version (V1) has been retained, and you can view it through /v1/index.html.
• Print It: You can now print the To-Do list that you created.
• Save/Load: Save your calendar to local storage and load the last saved one to continue your work.
• Remind Me: A reminder button has been added (a lot of work is needed on this).
• Heatmap: (Non-functional)
• Achievements: Achievements have been included just for fun. 😅
• Type It: You can now type anything (A-Z), (0-9), (!-/), and more.

Let Me Know

If you find anything faulty or with bugs, please never hesitate to inform me. I left it as is because I can’t solve it for now. If you are an expert, please feel free to solve it and submit a pull request.

അപ്പോൾ എല്ലാം പറഞ്ഞത് പോലെ Happy Coding!