{"id":30666225,"url":"https://github.com/zeeshier/git-readme-ai","last_synced_at":"2025-08-31T21:48:40.575Z","repository":{"id":305291557,"uuid":"1022495202","full_name":"Zeeshier/git-readme-ai","owner":"Zeeshier","description":"Instantly generate beautiful, professional README files for any GitHub repository using AI.","archived":false,"fork":false,"pushed_at":"2025-07-22T14:58:00.000Z","size":6444,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-31T21:48:38.391Z","etag":null,"topics":["ai","gen-ai","git-readme","langchain","python","readme-generator"],"latest_commit_sha":null,"homepage":"https://git-readme-ai-mu.vercel.app","language":"Python","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/Zeeshier.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,"zenodo":null}},"created_at":"2025-07-19T07:35:40.000Z","updated_at":"2025-07-22T14:58:27.000Z","dependencies_parsed_at":"2025-07-19T12:11:21.153Z","dependency_job_id":"63020c17-fc6e-4945-b204-0e65567c7c31","html_url":"https://github.com/Zeeshier/git-readme-ai","commit_stats":null,"previous_names":["zeeshier/git-readme-ai"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Zeeshier/git-readme-ai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeeshier%2Fgit-readme-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeeshier%2Fgit-readme-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeeshier%2Fgit-readme-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeeshier%2Fgit-readme-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zeeshier","download_url":"https://codeload.github.com/Zeeshier/git-readme-ai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeeshier%2Fgit-readme-ai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273046451,"owners_count":25036179,"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-31T02:00:09.071Z","response_time":79,"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":["ai","gen-ai","git-readme","langchain","python","readme-generator"],"created_at":"2025-08-31T21:48:39.307Z","updated_at":"2025-08-31T21:48:40.530Z","avatar_url":"https://github.com/Zeeshier.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 GitReadme AI\n\n**Instantly generate beautiful, professional README files for any GitHub repository using AI.**\n\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n![Built with FastAPI](https://img.shields.io/badge/backend-FastAPI-009688?logo=fastapi)\n![Frontend](https://img.shields.io/badge/frontend-HTML%2FCSS%2FJS-blue?logo=html5)\n![LangChain](https://img.shields.io/badge/AI-LangChain%20%2B%20Groq-purple)\n\n---\n\n## 🎬 Demo\n\n\u003cvideo src=\"test/demo.mp4\" width=500 height=400  controls\u003e\u003c/video\u003e\n\n---\n\n## ✨ Features\n\n- **AI-powered README generation** using LangChain and Groq LLMs\n- **Modern, beautiful UI** with glassmorphism and responsive design\n- **Live Markdown preview** with copy/download options\n- **Real GitHub repo analysis** (fetches actual file structure for accurate docs)\n- **FastAPI backend** for robust, scalable API\n- **Easy to use:** just paste a GitHub repo URL and get a ready-to-use README\n\n---\n\n## 📦 Tech Stack\n\n- **Backend:** Python, FastAPI, LangChain, Groq LLM\n- **Frontend:** HTML, CSS (Poppins font, glassmorphism), JavaScript\n- **Markdown Rendering:** [marked.js](https://marked.js.org/)\n- **GitHub API** for real repo analysis\n\n---\n\n## 🚀 Quick Start\n\n### 1. Clone the repository\n\n```bash\ngit clone https://github.com/yourusername/git-readme-ai.git\ncd git-readme-ai\n```\n\n### 2. Backend Setup\n\n```bash\ncd backend\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\npip install -r requirements.txt\n```\n\n- Create a `.env` file with your Groq API key:\n  ```\n  GROQ_API_KEY=your_groq_api_key_here\n  ```\n\n- Start the FastAPI server:\n  ```bash\n  uvicorn main:app --reload\n  ```\n\n### 3. Frontend Usage\n\n- Open `frontend/index.html` in your browser.\n\n---\n\n## 🎯 Usage\n\n1. Enter a GitHub repository URL (e.g., `https://github.com/vercel/next.js`)\n2. Click **Generate README**\n3. View the AI-generated README in a beautiful, live Markdown preview\n4. Copy or download the README for your project\n\n---\n\n## 🏗️ Project Structure\n\n```\ngit-readme-ai/\n├── backend/\n│   ├── main.py\n│   ├── requirements.txt\n│   └── ...\n├── frontend/\n│   ├── index.html\n│   ├── style.css\n│   ├── script.js\n│   └── ...\n└── .env\n```\n\n---\n\n## 🛠️ Customization\n\n- **Prompt:** Edit the system prompt in `backend/main.py` or `prompts.py` to fine-tune README style.\n- **UI:** Tweak `frontend/style.css` for your own color palette or branding.\n\n---\n\n## 📄 License\n\nMIT\n\n---\n\n## 🙏 Credits\n\n- [LangChain](https://github.com/langchain-ai/langchain)\n- [Groq](https://groq.com/)\n- [FastAPI](https://fastapi.tiangolo.com/)\n- [marked.js](https://marked.js.org/)\n\n---\n\n\u003e Built by zeeshier\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeeshier%2Fgit-readme-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeeshier%2Fgit-readme-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeeshier%2Fgit-readme-ai/lists"}