GitHub Repo Card Generator

GitHub Repo Card Generator is a feature-rich application designed for effortlessly creating SVG cards that showcase GitHub repositories.

Repository cards can be generated using the user interface and entering the GitHub username and repository name.
The card colors can be customized by clicking on the color pickers and selecting a color.

The generated SVG card will be displayed along with BBCode, HTML, and Markdown quick copy codes for embedding the card.

Features

• Generates SVG cards for GitHub repositories with customizable colors and options
• Lightweight responsive UI with quick copy codes (BBCode, HTML, Markdown) for embedding the output SVG card
• Configurable cache supported by SQLite
• Optionally limits the number of requests per hour to the GitHub API

Screenshots

Examples

Demo

A demo of the application is available at https://ghc.clait.sh.
The capacity of the demo server is limited and the caching policy aggressive, I suggest you to run your own instance of the application.

Setup

Local Setup

1. Clone the repository

git clone https://github.com/yourusername/github-repo-card-generator.git

2. Install dependencies

npm install

3. Rename .env.example in the root directory to .env add your GitHub token and configuration:

GITHUB_TOKEN=your_github_token

4. Start the server

npm start

The server will start running at http://localhost:3000.

Docker Setup

This application is also available as a Docker image on Docker Hub.

1. Pull the Docker image:

docker pull claitz/github-repo-card-generator

2. 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

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

Usage

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

The generated SVG card will be displayed along with BBCode, HTML, and Markdown quick copy codes for embedding the card.

The repository must be public.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Creative Commons Attribution Share Alike 4.0 International