Skip to content

Repository files navigation


     



✨ Generate animated, elite GitHub README cards with multiple themes.
Drop one URL into your README — get a stunning animated card back.



🎨 Themes


🌸 Anime

⚡ Cyber

💜 Neon

🍭 Kawaii

⚡ Features

🎭 Design 🛠 Technical 🚀 Deployment
Animated SVG cards Fast Next.js API Vercel-ready
4+ unique themes TypeScript powered Zero-config deploy
Custom tags & roles REST endpoint Edge-compatible
Social links support README markdown output CDN cached

✦ Animated SVG GitHub cards      ✦ Custom tags & roles
✦ Multiple unique themes          ✦ Social links support
✦ Live API generation             ✦ README-ready markdown
✦ Fast Next.js API routes         ✦ Vercel deployment support

🚀 Live Demo


🛠 Usage

Simply paste this one-liner into any GitHub README:

![My Card](https://card-api-three.vercel.app/api/card?theme=anime&name=YourName&role=Developer)

Result: A beautiful animated SVG card, rendered inline — no setup required.

<!-- Anime theme example -->
![Card](https://card-api-three.vercel.app/api/card?theme=anime&name=Ghada&initials=GC&role=Full+Stack+Developer&tags=React,Next.js,TypeScript&github=https://github.com/YOUR_USERNAME)

<!-- Cyber theme example -->
![Card](https://card-api-three.vercel.app/api/card?theme=cyber&name=Ghada&initials=GC&role=Backend+Engineer&tags=Node.js,Python,Docker)

<!-- Neon theme example -->
![Your Name's GitHub Card](https://card-api-three.vercel.app/api/card?theme=neon&name=Your+Name&initials=YN&role=Full-Stack+Developer&tags=React%2CTypeScript%2CNode.js%2COpen+Source&github=https%3A%2F%2Fgithub.com%2Fyourname&twitter=https%3A%2F%2Ftwitter.com%2Fyourname)

📚 API Parameters

Parameter Type Description Example
theme string Card visual theme anime · cyber · neon · kawaii
name string Display name shown on card Ghada
initials string Avatar initials (1–2 chars) GC
role string Main role or title Full Stack Developer
tags string Comma-separated skill tags React,Next.js,TypeScript
github string GitHub profile URL https://github.com/YOUR_USERNAME
linkedin string LinkedIn profile URL https://linkedin.com/in/...
color string Override accent color (hex) ff6b9d

Tip: All parameters are URL-safe. Use + for spaces in values.


📦 Installation

# 1. Clone the repository
git clone https://github.com/ghada-ch/card-api.git

# 2. Navigate to project directory
cd card-api

# 3. Install dependencies
npm install

# 4. Start the development server
npm run dev

App runs at http://localhost:3000

☁️ Deploy to Vercel (One Click)

Deploy with Vercel
# Or via Vercel CLI
npm i -g vercel
vercel --prod

🧩 Built With


Layer Technology
Framework Next.js 15 (App Router)
Language TypeScript 5
Card Format Animated SVG
API Next.js Route Handlers
Hosting Vercel Edge Network
Styling CSS-in-SVG + Keyframe Animations

🛣 Roadmap

  • Anime, Cyber, Neon, Kawaii themes
  • Custom name, role, and tags
  • Social links integration
  • Vercel API deployment
  • Particle effects overlay
  • Glassmorphism theme
  • Custom gradients via URL param
  • Theme marketplace (community-contributed)
  • User accounts & saved configurations
  • Card analytics (view counts)

🤝 Contributing

Contributions make this project grow. All help is appreciated.

# Fork → Clone → Branch → Commit → PR
git checkout -b feature/your-amazing-theme
git commit -m "feat: add glassmorphism theme"
git push origin feature/your-amazing-theme
  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'feat: add AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

💡 Have an idea? Open an issue — theme suggestions especially welcome.


⭐ Support

If this project helped you, a star means the world. ✨



It keeps the project alive, motivates new themes, and helps others discover it.


📄 License

Distributed under the MIT License — free to use, modify, and distribute.

See LICENSE for full details.


👤 Author


Ghada Chouichi
Full Stack Developer · Open Source Enthusiast


   

Built with 💜 by Ghada Chouichi · Powered by Next.js + Vercel

Releases

Packages

Contributors

Languages