{"id":23709966,"url":"https://github.com/iryna-vyshniak/github-report","last_synced_at":"2025-08-19T11:12:23.041Z","repository":{"id":269484487,"uuid":"891689318","full_name":"Iryna-Vyshniak/github-report","owner":"Iryna-Vyshniak","description":"🧾 Your GitHub contribution statement! View your open-source balance, commit history, and activity stats as a printed receipt. Earn more stars, fork projects, and level up your GitHub journey! 💾⚡","archived":false,"fork":false,"pushed_at":"2025-02-25T09:48:54.000Z","size":1702,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-30T06:21:42.246Z","etag":null,"topics":["html-to-image","jsbarcode"],"latest_commit_sha":null,"homepage":"https://github-report.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Iryna-Vyshniak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-20T19:25:40.000Z","updated_at":"2025-02-25T09:48:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"e0a01ea5-8ad3-4b29-8448-f96eb58d43c0","html_url":"https://github.com/Iryna-Vyshniak/github-report","commit_stats":null,"previous_names":["iryna-vyshniak/github-report"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Iryna-Vyshniak/github-report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iryna-Vyshniak%2Fgithub-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iryna-Vyshniak%2Fgithub-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iryna-Vyshniak%2Fgithub-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iryna-Vyshniak%2Fgithub-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Iryna-Vyshniak","download_url":"https://codeload.github.com/Iryna-Vyshniak/github-report/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iryna-Vyshniak%2Fgithub-report/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271143398,"owners_count":24706346,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html-to-image","jsbarcode"],"created_at":"2024-12-30T18:59:24.111Z","updated_at":"2025-08-19T11:12:23.028Z","avatar_url":"https://github.com/Iryna-Vyshniak.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📊 GitHub Report\n\nGitHub Report is a **Next.js \u0026 React** app that generates a **printable GitHub contribution summary**. Using **GitHub API, html-to-image, and jsbarcode**, it creates a visually appealing report with key statistics such as repositories, stars, forks, and commits.\n\n---\n\n## 🚀 Features\n\n- 🔄 **Dynamic Data Fetching** – Retrieves user data from GitHub API.\n- 🏷 **Barcode Generation** – Encodes GitHub usernames into barcodes.\n- 🖼 **Export Options** – Save your report as an image or share it.\n- 🎨 **Styled as a Receipt** – Unique transaction-style contribution summary.\n- ♿ **Accessibility Optimizations** – Semantic HTML and ARIA attributes.\n- 🌙 **Dark Mode Support** – Adapts to system theme.\n\n---\n\n## 📦 Tech Stack\n\n- **Next.js 15** – Server-side rendering \u0026 API routes.\n- **React 19** – Component-based UI.\n- **GitHub API** – Fetches user contribution stats.\n- **html-to-image** – Converts reports to images.\n- **jsbarcode** – Generates barcodes.\n- **Tailwind CSS** – Responsive and modern styling.\n\n---\n\n## 🛠 Installation\n\n1. **Clone the repository**\n\n   ```sh\n   git clone https://github.com/Iryna-Vyshniak/github-report.git\n   cd github-report\n   ```\n\n2. **Install dependencies**\n\n   ```sh\n   npm install\n   ```\n\n   _or_\n\n   ```sh\n   yarn install\n   ```\n\n3. **Set up environment variables**\n\n   - Create a `.env.local` file and add the following:\n     `env\nNEXT_PUBLIC_GITHUB_API=https://api.github.com/users/\nNEXT_PUBLIC_REPOS_URL=https://api.github.com/repos/\nNEXT_PUBLIC_COMMITS_URL=https://api.github.com/search/commits?q=author:\nNEXT_PUBLIC_GITHUB_TOKEN=your token\n`\n\n4. **Run the development server**\n   ```sh\n   npm run dev\n   ```\n   _or_\n   ```sh\n   yarn dev\n   ```\n\n---\n\n## 📸 Screenshots\n\n\u003cimg src=\"./public/github-report-iryna-vyshniak.jpeg\" alt=\"GitHub Report\" width=\"320\"/\u003e\n\u003cimg src=\"./public/screenshot_1.jpeg\" alt=\"GitHub Report\" width=\"320\"/\u003e\n\u003cimg src=\"./public/screenshot_2.jpeg\" alt=\"GitHub Report\" width=\"320\"/\u003e\n\n---\n\n## 📜 Usage\n\n1. Enter a **GitHub username**.\n2. Click the **Print button** to generate the report.\n3. View your **GitHub contribution summary**.\n4. **Download** or **share** your report as an image.\n\n---\n\n## 📌 Roadmap\n\n- [ ] Add **multi-language support** 🌍\n- [ ] Allow **custom styling** for receipts 🎨\n- [ ] Improve **mobile responsiveness** 📱\n- [ ] Implement **PDF export option** 📝\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! 🎉 If you'd like to improve the project:\n\n1. **Fork the repo**\n2. **Create a feature branch** (`git checkout -b feature-name`)\n3. **Commit your changes** (`git commit -m 'Add some feature'`)\n4. **Push to the branch** (`git push origin feature-name`)\n5. **Open a Pull Request** 🚀\n\n---\n\n## 📜 License\n\nMIT License © [Iryna-Vyshniak](https://github.com/Iryna-Vyshniak)\n\n---\n\n## 💡 Inspiration\n\nInspired by the concept of **gamifying open-source contributions**, this project turns GitHub activity into a **receipt-style report** for a fun and interactive experience. 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firyna-vyshniak%2Fgithub-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firyna-vyshniak%2Fgithub-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firyna-vyshniak%2Fgithub-report/lists"}