Skip to content

husnainfareed/github-receipt

Repository files navigation

GitHub Receipt Generator

A modern web application that generates a receipt-style summary of GitHub profiles.

GitHub Receipt Generator

🌟 Features

  • Profile Summary: Generates a detailed receipt-style summary of any GitHub profile
  • Comprehensive Stats: Shows repositories, stars, forks, followers, and following
  • Language Analysis: Displays most used programming languages
  • Activity Metrics:
    • Most active day of the week
    • 30-day commit count
    • Custom contribution score
  • Export Options:
    • Download receipt as PNG
    • Share functionality (coming soon)
  • Responsive Design: Works seamlessly on both desktop and mobile devices

➕ Adding Features

  • guestbook with the users github username

🚀 Tech Stack

  • Framework: Next.js 14
  • Styling: Tailwind CSS
  • UI Components: Radix UI
  • Typography: Custom receipt-style design using Roboto Mono
  • Image Generation: html2canvas
  • Date Formatting: date-fns
  • Icons: Lucide React
  • Language: TypeScript

📦 Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/github-receipt-generator.git
  2. Navigate to the project directory:

    cd github-receipt-generator
  3. Install dependencies:

    npm install
    # or
    pnpm install
    # or
    yarn install
  4. Start the development server:

    npm run dev
    # or
    pnpm dev
    # or
    yarn dev
  5. Open http://localhost:3000 in your browser.

🤝 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 licensed under the MIT License - see the LICENSE file for details.

About

Generate a receipt-style summary of your GitHub profile

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published