{"id":25857737,"url":"https://github.com/owengretzinger/gitreadme","last_synced_at":"2025-03-01T19:17:45.815Z","repository":{"id":276233604,"uuid":"927933905","full_name":"owengretzinger/gitreadme","owner":"owengretzinger","description":"Instantly generate high-quality README files using AI that understands your codebase","archived":false,"fork":false,"pushed_at":"2025-03-01T05:28:23.000Z","size":9414,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T06:23:36.663Z","etag":null,"topics":["drizzle-orm","google-cloud-platform","nextjs","postgresql","python","shadcn-ui","tailwindcss","trpc","typescript"],"latest_commit_sha":null,"homepage":"https://gitreadme.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/owengretzinger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2025-02-05T19:29:56.000Z","updated_at":"2025-03-01T05:28:27.000Z","dependencies_parsed_at":"2025-03-01T06:35:40.573Z","dependency_job_id":null,"html_url":"https://github.com/owengretzinger/gitreadme","commit_stats":null,"previous_names":["owengretzinger/readme-generator","owengretzinger/gitreadme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owengretzinger%2Fgitreadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owengretzinger%2Fgitreadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owengretzinger%2Fgitreadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owengretzinger%2Fgitreadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/owengretzinger","download_url":"https://codeload.github.com/owengretzinger/gitreadme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241411476,"owners_count":19958754,"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","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":["drizzle-orm","google-cloud-platform","nextjs","postgresql","python","shadcn-ui","tailwindcss","trpc","typescript"],"created_at":"2025-03-01T19:17:44.692Z","updated_at":"2025-03-01T19:17:45.795Z","avatar_url":"https://github.com/owengretzinger.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://gitreadme.dev/favicon.ico\" alt=\"gitreadme.dev Logo\" width=\"80\" height=\"80\"\u003e\n\n\u003ch3 align=\"center\"\u003e\u003ca href=\"https://gitreadme.dev\"\u003egitreadme.dev\u003c/a\u003e\u003c/h3\u003e\n  \u003cp align=\"center\"\u003e\n    Instantly generate high-quality README files using AI that understands your codebase\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003c!-- \u003cli\u003e\u003ca href=\"#demo\"\u003eDemo\u003c/a\u003e\u003c/li\u003e --\u003e\n        \u003cli\u003e\u003ca href=\"#key-features\"\u003eKey Features\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#architecture\"\u003eArchitecture\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n## About The Project\n\nThis project was originally built as part of [HackMate](https://github.com/owengretzinger/hackmate) for the GDG Mac-a-Thon 2025, which won 1st overall.\n\n\u003c!-- ### Demo\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://youtu.be/sD66NuLWxFw?si=YTVOI7qggv-7y0mL\u0026t=23\"\u003e\n    \u003cimg src=\"https://github.com/user-attachments/assets/6153bf9a-325a-4df2-a8c7-3f9afab40a38\" alt=\"HackMate Demo\"\u003e\n  \u003c/a\u003e\n  \u003cp\u003e\n    Click the image to see a short demo (HackMate demo video)\n  \u003c/p\u003e\n\u003c/div\u003e --\u003e\n\n### Key Features\n\n- **AI-Powered README Generation:** Generates README files using AI that understands your codebase.\n- **Architecture Diagram Generation:** Creates architecture diagrams to visualize the structure of your project.\n- **Integration with Vertex AI:** Leverages Google Cloud Vertex AI for AI-powered features.\n- **Next.js Frontend:** Modern and responsive user interface built with Next.js.\n- **TRPC API:** Type-safe API communication between frontend and backend.\n- **Authentication:** Secure user authentication using NextAuth.js and Google Provider.\n\n## Architecture\n\n- **Frontend:**\n  - Next.js (T3 Stack)\n  - TypeScript\n  - Shadcn UI\n  - Tailwind CSS\n  - Next-themes for dark/light mode support\n- **Backend (Next.js)**\n  - tRPC (type-safe communication between frontend and backend)\n  - Postgres Database (hosted on Neon)\n  - Drizzle ORM with drizzle-kit for migrations\n  - Vercel for deployment\n- **Repo Packing Service:**\n  - Python\n  - gitingest\n  - Google Cloud Run\n\n## Todo\n\n- [ ] Ability to create multiple READMEs for the same repo using query params\n- [ ] PostHog\n- [ ] Add FAQ\n- [ ] Add next steps/tips after README is generated\n- [ ] Add name to bottom of the page\n- [ ] Add more templates\n- [ ] Film demo video\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowengretzinger%2Fgitreadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fowengretzinger%2Fgitreadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowengretzinger%2Fgitreadme/lists"}