umbrella-h / habitica-stat-box

Show my Habitica status in a pinned Gist.

habitica-stat-box

Show my Habitica status in a pinned Gist to build social motivation for developing good habits.

^{_{Inspired by kylemocode/medium-stat-box. Powered by GitHub Actions, GrabzIt, and habitica-avatar}}

@khno3 🥷 Level 72 Rogue 
🩸 Health 50/50 💪 Exp 901/2160 💎 Mana 160/160
> Every pet 🦊, equipment 🗡, or level up 🔺
> represents my dedication to
> developing good habits 👏

I am now improving the feature which shows the latest avatar in a Gist.

What is Habitica?

Habitica is an open sourced habit tracker app which treats your goals like a Role Playing Game.

If you are interested in the game mechanics, please check their fandom page, for example, Damage to Player in Habitica.

Prerequisites

1. Sign up for Habitica.

2. Sign up for GrabzIt if you want to show your avatar image as well. (Please check the limitation for free accounts.)

   The Update Avatar Gist action is unstable now. Please check Reported Bugs.

3. Fork this repository.

4. Create new public GitHub Gists (https://gist.github.com/)

5. Create a token with the gist scope. (https://github.com/settings/tokens/new)

6. Take a look at .env.template and create your Repository Secrets of Actions (Guides for creating encrypted secrets for a repository).

Usage

1. Enable Update Stats Gist workflow in your repository.

   The Update Avatar Gist action is unstable now. Please check Reported Bugs.

2. The cron job runs every 2 hours between 00:05 ~ 16:05 UTC. Manual workflow_dispatch trigger is also available.

3. Pin your Gist in your Github profile page.

Reported Bugs

1. The Update Avatar Gist action is unstable now. Please check umbrella-h/habitica-stat-box/issues #14. Before the bug is fixed, it is recommanded to disable it. if you still want to update the image in you gist, please trigger it manually, and check the result to see if a retry is needed.
2. GitHub will suspend the scheduled trigger for GitHub action workflows if there is no commit in the repository for the past 60 days. I am trying to use gautamkrishnar/keepalive-workflow. Please check umbrella-h/habitica-stat-box/issues #18.

Development

Edit .env file, and run the command bellow for testing in development environment .

$ bundle exec rake dev_stats

$ bundle exec rake dev_avatar

Sequence Diagram

habitica-stat-box's Issues

[NTH] Error Handling

[Bug] Fix github action cron scheduling

[MVP] periodically upload my avatar image to Cloudinary

[doc] Fix typo in README

[MVP] Show username, level, class, Health, Exp, Mana by Gist

Besides, give it a try to
periodically update image (binary file) in a Gist.

see #6

[DEV] Add .env.template

for development env

[workflows] keep workflows alive

https://github.com/marketplace/actions/keepalive-workflow

[doc] Add commands and sequence diagrams in README for development

[Bug] Set a delay before scraping avatar image, or design a retry condition

See #6

[doc] add Readme & MIT license

[Bug] image cache problem

The image in my profile README
is not updated immediately as expected.
(Checked that the file in Cloudinary is updated successfully)

Clues:

• Cloudinary cache
• GitHub readme image cache
• browser cache