Pretty Banner is a Next.js-based service for generating beautiful, customizable SVG banners with GitHub profile statistics. It is designed for use in GitHub READMEs, personal websites, and dashboards, providing visually appealing, themeable, and informative profile cards.

• Fetches and visualizes GitHub user statistics (repos, stars, followers, languages, etc.)
• Generates SVG banners with multiple themes and custom backgrounds
• Supports custom color schemes and user-defined themes
• Optionally displays top programming languages
• Supports hiding the avatar and adding a custom "about me" text
• Fast, stateless API endpoint for easy integration

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=anime&hide_avatar=true

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=anime&langs=true

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=ancient

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=ancient&langs=true

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=simple

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=simple&langs=true

https://pretty-profile.vercel.app/api/github-stats?username=Nighty3098&theme=custom&fg=%23000000&bg=%236a55e8

GET /api/github-stats

/api/github-stats?username=Nighty3098&theme=night&show=stars,followers,commits&about_me=Open%20Source%20Enthusiast&hide_avatar=true&langs=true

• city
• forest
• japan
• night
• waterfall
• ancient
• solarized
• mac_bigsur
• mac_bigsur_dark
• white
• simple
• everforest_sea
• gradient
• anime

Each theme has its own background image and color palette. You can also use custom colors via fg and bg parameters.

• Custom Colors: Use fg and bg to override text and background colors.
• Custom Fields: Use show to select which stats to display.
• Languages: Set langs=true to show a bar of top languages.
• Avatar: Set hide_avatar=true to hide the profile picture.
• About Me: Add a custom message with about_me.

1. Clone the repository:

   git clone https://github.com/Nighty3098/pretty_banner.git
   cd pretty_banner
   

2. Install dependencies:

   yarn install
   # or
   npm install
   

3. Create a .env file and add your GitHub API tokens as GITHUB_TOKEN_PT1, GITHUB_TOKEN_PT2, ...
4. Run the development server:

   yarn dev
   # or
   npm run dev
   

5. Open http://localhost:3000 and use the API endpoint as described above.

• dev — Start Next.js in development mode
• build — Build the project for production
• start — Start the production server
• lint — Run ESLint with auto-fix
• format — Format code with Prettier

• TypeScript, React, Next.js
• Prettier and ESLint are configured (see .prettierrc.yaml and eslint.config.mjs)
• Main font: Iosevka Nerd Font

Please report bugs and suggestions via GitHub Issues.

This project is for personal use and demonstration. See repository for details.$$