made with ❤️ for Beaverhacks Spring 2024
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>
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.
- Clone the repo
git clone https://github.com/cassiusfive/gitpets.git- Get environment variables
cp .env.example .envImportant
You'll need to generate a Github personal access token to track activity. It does not need any special permissions.
- Start the project
docker compose up -d