Skip to content

Transform your GitHub profile into a sleek, receipt-style image showcasing your stats and top repositories. Perfect for developers who love to quantify their achievements!

Notifications You must be signed in to change notification settings

themrsami/github-receipt-generator

Repository files navigation

GitHub Receipt Generator

Transform your GitHub profile into a sleek, receipt-style image showcasing your stats and top repositories. Perfect for developers who love to quantify their achievements!

Features

  • Generate a receipt-style image of GitHub user profiles
  • Display key GitHub stats (followers, following, public repos)
  • Show top 5 repositories by star count
  • Dark mode support
  • Downloadable receipt as a PNG image

Installation

  1. Clone the repository:
git clone https://github.com/themrsami/github-receipt-generator.git
  1. Navigate to the project directory:
cd github-receipt-generator
  1. Install dependencies:
pnpm install
  1. Start the development server:
pnpm dev --turbo
  1. Open http://localhost:3000 in your browser to see the application.

Usage

  1. Enter a GitHub username in the input field.
  2. Click the "Generate Receipt" button.
  3. View the generated receipt with the user's GitHub stats and top repositories.
  4. Click the "Download Receipt" button to save the receipt as a PNG image.

Technologies Used

Project Structure

  • app/: Contains the main application files

  • layout.tsx: Root layout component

  • page.tsx: Main page component

  • components/: Reusable React components

  • footer.tsx: Footer component

  • hero.tsx: Hero section component

  • mode-toggle.tsx: Dark mode toggle component

  • navbar.tsx: Navigation bar component

  • receipt-generator.tsx: Main receipt generator component

  • receipt.tsx: Receipt display and download component

  • theme-provider.tsx: Theme provider for dark mode support

  • public/: Static assets

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is open source and available under the MIT License.

Contact

Usama Nazir - @themrsami

Project Link: Github Receipt Generator


Made with ❤️ by Usama

About

Transform your GitHub profile into a sleek, receipt-style image showcasing your stats and top repositories. Perfect for developers who love to quantify their achievements!

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published