Skip to content

README.md

Latest commit

 

History

History
67 lines (46 loc) · 2.46 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.46 KB

gitpets

Virtual pets for your README!

made with ❤️ for Beaverhacks Spring 2024

License

License

Usage

Shows a gitpet

Copy and paste the following snippet into your README

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://gitpets.fly.dev/api?username=cassiusfive&petname=lorem+ipsum&theme=dark&species=fox">
  <source media="(prefers-color-scheme: light)" srcset="https://gitpets.fly.dev/api?username=cassiusfive&petname=lorem+ipsum&theme=light&species=fox">
  <img alt="Shows a gitpet" src="https://gitpets.fly.dev/api?username=cassiusfive&petname=lorem+ipsum&theme=dark&species=fox" width="200px">
</picture>

API Reference

https://gitpets.fly.dev/api

Parameter Required Description Options
username Yes Github username N/A
petname Yes Desired name of pet N/A
species Yes Desired species of pet fox, wolf, bunny
theme No The theme for UI light, dark

Note

Pets will gain experience based on your commits, merged PRs and unique repos you've contributed to.

Development

  1. Clone the repo
git clone https://github.com/cassiusfive/gitpets.git
  1. Get environment variables
cp .env.example .env

Important

You'll need to generate a Github personal access token to track activity. It does not need any special permissions.

  1. Start the project
docker compose up -d