Skip to content

Getting Started

Jump to bottom
Ferran Buireu edited this page Jun 13, 2026 · 3 revisions

Getting Started

There's nothing to install to use ContribKit — it works with any public GitHub username. Pick the path that fits you.

1. Use the web app

  1. Open contribkit.app.
  2. Type a GitHub username and hit render.
  3. Tweak the palette, shape, and background in the customizer.
  4. Copy or export from the export section (PNG, SVG, or Markdown).

No login, no token — ContribKit only reads public contribution data.

2. Embed it in your README

The simplest embed renders your calendar live every time someone views your profile:

![contributions](https://contribkit.app/user/YOUR_USERNAME.svg)

With customization:

![contributions](https://contribkit.app/user/YOUR_USERNAME.svg?palette=catppuccin&shape=hex&background=transparent)

Unknown option values silently fall back to the default, so the image never breaks. See API Reference for every parameter.

3. Install the mobile app

  1. Install from Google Play (App Store coming soon).
  2. Enter your username.
  3. Add a widget to your home screen — small (streak counter), medium (full grid), or large (both).

Widgets refresh once a day in the background. See Mobile App for details.

4. Run it locally

ContribKit is a pnpm monorepo. To work on the web app:

pnpm install
cd web
pnpm dev

For the Flutter app and shared design tokens, see Project Structure and Web Application / Mobile App.

Next steps

Clone this wiki locally