An open API service indexing awesome lists of open source software.

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

Awesome Lists containing this project

README

        


gitreadme.dev Logo

gitreadme.dev



Instantly generate high-quality README files using AI that understands your codebase


Table of Contents



  1. About The Project


  2. Architecture

## 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