https://github.com/owengretzinger/gitreadme
Instantly generate high-quality README files using AI that understands your codebase
https://github.com/owengretzinger/gitreadme
drizzle-orm google-cloud-platform nextjs postgresql python shadcn-ui tailwindcss trpc typescript
Last synced: 3 months ago
JSON representation
Instantly generate high-quality README files using AI that understands your codebase
- Host: GitHub
- URL: https://github.com/owengretzinger/gitreadme
- Owner: owengretzinger
- Created: 2025-02-05T19:29:56.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-01T05:28:23.000Z (3 months ago)
- Last Synced: 2025-03-01T06:23:36.663Z (3 months ago)
- Topics: drizzle-orm, google-cloud-platform, nextjs, postgresql, python, shadcn-ui, tailwindcss, trpc, typescript
- Language: TypeScript
- Homepage: https://gitreadme.dev
- Size: 8.98 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## About The Project
This project was originally built as part of [HackMate](https://github.com/owengretzinger/hackmate) for the GDG Mac-a-Thon 2025, which won 1st overall.
### Key Features
- **AI-Powered README Generation:** Generates README files using AI that understands your codebase.
- **Architecture Diagram Generation:** Creates architecture diagrams to visualize the structure of your project.
- **Integration with Vertex AI:** Leverages Google Cloud Vertex AI for AI-powered features.
- **Next.js Frontend:** Modern and responsive user interface built with Next.js.
- **TRPC API:** Type-safe API communication between frontend and backend.
- **Authentication:** Secure user authentication using NextAuth.js and Google Provider.## Architecture
- **Frontend:**
- Next.js (T3 Stack)
- TypeScript
- Shadcn UI
- Tailwind CSS
- Next-themes for dark/light mode support
- **Backend (Next.js)**
- tRPC (type-safe communication between frontend and backend)
- Postgres Database (hosted on Neon)
- Drizzle ORM with drizzle-kit for migrations
- Vercel for deployment
- **Repo Packing Service:**
- Python
- gitingest
- Google Cloud Run## Todo
- [ ] Ability to create multiple READMEs for the same repo using query params
- [ ] PostHog
- [ ] Add FAQ
- [ ] Add next steps/tips after README is generated
- [ ] Add name to bottom of the page
- [ ] Add more templates
- [ ] Film demo video