Skip to content

matheusconaga/github-project-cards

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎴 GitHub Project Cards

Generate beautiful and customizable GitHub project cards for your README, portfolio or profile.

Project Card

Next.js React TypeScript Satori Vercel

Live Preview


πŸ“Œ About

GitHub Project Cards is an open source project that generates customizable SVG cards for GitHub repositories.

You can use the generated cards inside:

  • GitHub READMEs
  • Portfolio websites
  • Profile pages
  • Documentation pages
  • Personal showcases

The project includes a live preview builder where users can customize their cards in real time and copy the final markdown instantly.


🎨 Themes

Theme Preview
Dark GitHub Project Card preview in Dark theme
Light GitHub Project Card preview in Light theme
GitHub GitHub Project Card preview in GitHub theme
Dracula GitHub Project Card preview in Dracula theme

🌍 Supported Locales

PT-BR English


🧩 Customization

Supported Parameters

Parameter Description
repo GitHub repository
theme Card theme
lang Locale language
image Custom image
techs Custom technologies
showStars Show repository stars
showForks Show repository forks

πŸ› οΈ Usage

![Project Card](https://github-project-cards.vercel.app/api/project-card?repo=username/repository)

πŸ’» Run Locally

πŸ“₯ 1. Clone the repository:

git clone [https://github.com/matheusconaga/github-project-cards.git](https://github.com/matheusconaga/github-project-cards.git)

πŸ“‚ 2. Enter the project folder:

cd github-project-cards

πŸ“¦ 3. Install dependencies:

npm install

or

npm i

▢️ 4. Run the project:

npm run dev

πŸš€ Deploy

Deploy your own version easily on Vercel.

πŸ‘₯ Users

People and developers using GitHub Project Cards:

matheusconaga

Want to appear here? Open a Pull Request adding your profile image and GitHub link.

🀝 Contributing

Contributions are always welcome!

You can contribute by:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Creating new themes
  • Improving performance
  • Refactoring code
  • Opening Pull Requests

To contribute:

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to your fork
  5. Open a Pull Request

Any contribution, big or small, is appreciated πŸ’™

πŸ“„ License

This project is licensed under the MIT License.
See the LICENSE file for more details.

πŸ’™ Support

If you like this project, give it a ⭐ and share it with friends!

About

Open-source tool to generate beautiful, customizable GitHub project cards with live preview, themes, and easy integration for READMEs and portfolios.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors