claitz/github-repo-card-generator repository overview

⁠GitHub Repo Card Generator Docker Image

This Docker image allows you to run the GitHub Repo Card Generator application, which generates SVG cards for GitHub repositories.

⁠Usage

1. Pull the Docker image:

docker pull claitz/github-repo-card-generator

1. Run the Docker container, replacing your_github_token with your GitHub token:

docker run -p 3000:3000 -e GITHUB_TOKEN=your_github_token -e PUBLIC_URL=your_public_url claitz/github-repo-card-generator

1. Replace your_public_url with the public-facing URL (e.g., https://example.com⁠).

Once the container is running, navigate to http://localhost:3000 in your web browser (or your public URL if configured). Enter the GitHub username and repository name, customize the card colors if desired, and click "Generate" to generate an SVG card for the repository.

⁠Configuration

You can configure the container using the following environment variables:

  - GITHUB_TOKEN=
  - API_WINDOW=60
  - API_LIMIT=5
  - CACHE_LENGTH=60
  - PORT=3000
  - PUBLIC_URL=http://localhost:3000

⁠Screenshots

⁠Examples

⁠Support

If you encounter any issues or have questions, please refer to the GitHub repository for this project: GitHub Repo Card Generator Repository⁠