{"id":27957490,"url":"https://github.com/vikas-kashyap97/readme-generator","last_synced_at":"2026-04-10T20:44:19.024Z","repository":{"id":291247588,"uuid":"977050789","full_name":"vikas-kashyap97/Readme-Generator","owner":"vikas-kashyap97","description":"An AI-powered tool that automatically creates polished documentation for GitHub repositories. Analyzes code structure to detect tech stacks (React, Python, Java, etc.), counts lines of code, identifies live deployments, and generates professional README.md format.","archived":false,"fork":false,"pushed_at":"2025-05-03T10:38:31.000Z","size":7,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T18:13:13.633Z","etag":null,"topics":["dotenv","github-api","groq-api","langchain","streamlit"],"latest_commit_sha":null,"homepage":"https://aireadme-generator.streamlit.app/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vikas-kashyap97.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-05-03T10:08:51.000Z","updated_at":"2025-05-03T10:47:12.000Z","dependencies_parsed_at":"2025-05-03T11:41:42.355Z","dependency_job_id":null,"html_url":"https://github.com/vikas-kashyap97/Readme-Generator","commit_stats":null,"previous_names":["vikas-kashyap97/readme-generator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vikas-kashyap97%2FReadme-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vikas-kashyap97%2FReadme-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vikas-kashyap97%2FReadme-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vikas-kashyap97%2FReadme-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vikas-kashyap97","download_url":"https://codeload.github.com/vikas-kashyap97/Readme-Generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252931550,"owners_count":21827112,"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":["dotenv","github-api","groq-api","langchain","streamlit"],"created_at":"2025-05-07T18:13:17.271Z","updated_at":"2026-04-10T20:44:18.985Z","avatar_url":"https://github.com/vikas-kashyap97.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 Auto README.md Generator [![Live Demo](https://img.shields.io/badge/Live_Demo-Available-green)](https://aireadme-generator.streamlit.app/)\n\nAn AI-powered solution that automatically generates professional documentation for GitHub repositories. Analyzes code structure, detects tech stack, and creates polished READMEs in seconds!\n\n---\n\n## 🌟 Key Features\n\n- **Smart Tech Detection** 🔍  \n  Identifies React, Python, Java, Node.js, Flask, and 20+ technologies\n- **LOC Counter** 📈  \n  Calculates total lines of code with file type breakdown\n- **Live Link Detection** 🔗  \n  Automatically finds deployed URLs (Vercel/Netlify/Heroku)\n- **AI-Powered Writing** 🤖  \n  Uses Groq's Llama 3-8b for context-aware documentation\n- **Tone Customization** 🎭  \n  Professional/Casual/Detailed styles with one click\n\n---\n\n## 🛠️ Tech Stack\n\n| Component              | Technology                          |\n|------------------------|-------------------------------------|\n| **Frontend Framework** | Streamlit                           |\n| **AI Engine**          | Groq + Llama 3-8b                   |\n| **Document Processing**| LangChain                           |\n| **Version Control**    | GitHub API                          |\n| **Text Processing**    | RecursiveCharacterTextSplitter      |\n| **Environment**        | python-dotenv                       |\n\n---\n\n## ⚡ Quick Start\n\n1. **Access Live Demo**  \n   Visit [Auto README Generator](https://aireadme-generator.streamlit.app/)\n\n2. **Input GitHub URL**  \n   `https://github.com/username/repository`\n\n3. **Select Tone**  \n   Choose from Professional, Casual, or Detailed\n\n4. **Generate \u0026 Download**  \n   Get production-ready README.md in \u003c30s\n\n---\n\n## 🖥️ Local Installation\n\n```bash\n# Clone repository\ngit clone https://github.com/vikas-kashyap97/auto-readme-generator.git\ncd auto-readme-generator\n\n# Create virtual environment\npython -m venv venv\nsource venv/bin/activate  # Windows: venv\\Scripts\\activate\n\n# Install dependencies\npip install -r requirements.txt\n\n# Configure environment variables\necho \"GROQ_API_KEY=your_groq_key\" \u003e .env\necho \"GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token\" \u003e\u003e .env\n\n# Launch application\nstreamlit run app.py\n```\n## 📂 Supported File Types\n- Category\tExtensions\n- Frontend\t.js .ts .jsx .tsx .html .css\n- Backend\t.py .java .go .php .rb\n- Config\t.json .yml .env .gitignore\n- Docs\t.md .rst .txt\n\n\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [MIT License](LICENSE) file for details.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvikas-kashyap97%2Freadme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvikas-kashyap97%2Freadme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvikas-kashyap97%2Freadme-generator/lists"}