https://github.com/aakashsharma7/github-receipt
Generate a receipt-style summary of your GitHub profile. Showcase your repositories, stars, and contributions in a unique, receipt-style summary. It's the perfect way to visualize your GitHub journey and celebrate your coding milestones.
https://github.com/aakashsharma7/github-receipt
github github-profile github-receipt receipt
Last synced: 6 months ago
JSON representation
Generate a receipt-style summary of your GitHub profile. Showcase your repositories, stars, and contributions in a unique, receipt-style summary. It's the perfect way to visualize your GitHub journey and celebrate your coding milestones.
- Host: GitHub
- URL: https://github.com/aakashsharma7/github-receipt
- Owner: aakashsharma7
- License: agpl-3.0
- Created: 2024-12-09T12:23:46.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-13T17:11:54.000Z (9 months ago)
- Last Synced: 2025-02-13T19:40:39.883Z (8 months ago)
- Topics: github, github-profile, github-receipt, receipt
- Language: TypeScript
- Homepage: https://github-receipt-beta.vercel.app
- Size: 292 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Receipt Generator
Generate a receipt-style summary of your GitHub profile. Showcase your repositories, stars, and contributions in a unique, receipt-style summary. It's the perfect way to visualize your GitHub journey and celebrate your coding milestones.
## Table of Contents
- [Features](#features)
- [Usage](#usage)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
## Features
- Generate a visually appealing receipt-style summary of a GitHub user's profile
- Display key GitHub statistics including:
- Repositories count
- Stars earned
- Repo forks
- Followers and following count
- Top programming languages
- Commits in the last 30 days
- Contribution score
- Realistic receipt design with tear-off edges and a barcode
- Dark mode toggle
- Download receipt as an image
- Share receipt directly from the application
## Usage
1. Enter a GitHub username in the input field.
2. Click the "Generate" button or press Enter.
3. View the generated GitHub receipt.
4. Use the "Download" button to save the receipt as an image.
5. Use the "Share" button to share the receipt directly (on supported devices).
## Technologies Used
- Next.js
- React
- TypeScript
- Tailwind CSS
- shadcn/ui
- html2canvas
- jsbarcode
## License
This project is licensed under the GNU License.
---
Setup
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.