Skip to content

roboslone/habbitses

Repository files navigation

Habit tracker using your private GitHub repository as data storage.
Operates completely in browser, except for GitHub token exchange.

GitHub application

Quickstart

  1. Create a private repository:
github com_new_visibility=private name=habbitses data add-readme=true description=Data+for+https___roboslone github io_habbitses_
  1. Install Habbitses GitHub application:
github com_settings_installations_99406588
  1. Open https://roboslone.github.io/habbitses/, sign in with your GitHub account.

Setting up your own instance

To run your own instance of Habbitses you'll need several things:

  • GitHub code exchange server, you can use or fork mine or write your own supporting the same protocol
  • your server address and GitHub application client ID patched into src/lib/const.ts
  • GitHub pages enabled for your repo, pushes to main branch are published with GitHub workflow

If you're using my exchange server, don't forget to put it behind TLS termination proxy (e.g. nginx) and set up CORS to allow your domain(s).

GitHub rate limits

All requests within Habbitses will count towards your API rate limits.
At the time of writing limit is 15 000 requests per hour, so this should not be a problem.

Security and privacy

Code exchange server will have access to your access and refresh tokens.

So you should only install Habbitses to a single repository containing your habit data.

App doesn't have any trackers (other than for your habits, duh) or ads and doesn't collect any data.
However, it's technically possible for exchange server administrator to use your access token to read your repository contents and therefore your habit data, including broken habits (via git logs).

Screenshots

localhost_5173_habbitses_(iPhone 12 Pro) (1) localhost_5173_habbitses_(iPhone 12 Pro) (3) localhost_5173_habbitses_(iPhone 12 Pro) localhost_5173_habbitses_(iPhone 12 Pro) (2)

About

GitHub-backed habit tracker in your browser

Topics

Resources

License

Stars

Watchers

Forks