gitreadme.mov
Table of Contents
Using gitreadme.dev is as simple as inputting a repository URL and hitting generate. You can also replace "github.com" with "gitreadme.dev" inside any GitHub repo to immediately start generating a README for that repo.
Optionally, you can select & edit a template, provide additional instructions, and exclude specific files/folders from the analysis process.
Every generated README is assigned a unique URL so that it can be viewed and edited later, or even shared with others.
gitreadme.dev was originally built as part of HackMate for the GDG Mac-a-Thon 2025 (1st overall).
- Customizable Templates: Select from and customize a variety of templates to customize the look and feel of your README.
- File Exclusion: Exclude specific files/folders from the analysis process to reduce token count.
- Additional Instructions: Provide additional instructions to the AI to further customize the generated README files.
- Save & Share: README files are stored in a database with a unique URL and can be viewed and shared with others.
- User Authentication: Secure user authentication using NextAuth.js and Google Provider.
- Dashboard: View and manage generated README files.
- 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
-
Create venv (Python 3.10+) and install dependencies
cd repo-packerpython -m venv venv
source venv/bin/activatepip install -r requirements.txt
-
Create
.envfile based on.env.exampleand add aREPO_PACKER_TOKENvariable (used to authenticate between nextjs app and repo packing service). -
Run the service
python pack.py
-
Install dependencies for Next.js app
cd nextjspnpm install
-
Set up database
- Create a new database on Neon (or local)
-
Set up Google Cloud Project
- Enable Vertex AI API
- Create service account and download key as
key.json(some fields used in the next step) - Set up Google Auth
-
Create
.envfile based on.env.exampleand fill in the required environment variables. -
Run the development server
pnpm dev
Reach out via email (owengretzinger@gmail.com) or LinkedIn (https://www.linkedin.com/in/owengretzinger/) with any questions or feedback.
If this tool was helpful to you, please give it a star!