✨ GitDocsPro

GitDocsPro is an advanced AI-powered documentation generator. It seamlessly analyzes your public GitHub repositories—reading file structures, package.json dependencies, and languages—to automatically construct a world-class, professional README.md file.

Gone are the days of manually tweaking markdown. GitDocsPro guarantees perfectly aligned badges, visually stunning layouts, intelligent quick-start instructions, and accurate system architecture diagrams.

• 🧠 Intelligent Repository Analysis: Automatically reads your repository via the GitHub API to detect package managers (npm, pnpm, yarn), commands, and framework dependencies.
• 🎨 Visually Stunning Output: Generates clean, GitHub-flavored markdown with styled UI components, Mermaid.js diagrams, badges, and tech stack tables.
• 🔒 Secure & Stateless: Authenticates via NextAuth (GitHub OAuth) using stateless JWTs. No complex database setup is required.
• ⏱️ Enterprise Rate Limiting: Built-in sliding window rate limiting (Upstash Redis) to prevent API abuse and handle heavy traffic reliably.
• 🌐 Benchmark & Audience Modes: Tailor your README tone for Startups, Open Source, or Enterprise standards.

Getting GitDocsPro running locally is incredibly simple. Out of the box, it is completely stateless.

• Node.js 18+
• A valid GitHub OAuth Application (Create one in Developer Settings)
• A Bytez or OpenAI API Key

1. Clone the repository:

   git clone https://github.com/Dev-Suraj-Dhawal/my-readme-app.git
   cd my-readme-app/readme-gen-pro

2. Install dependencies:

   npm install

3. Configure Environment Variables: Rename .env.example to .env.local and populate your keys:

   NEXTAUTH_URL=http://localhost:3000
   NEXTAUTH_SECRET=generate_a_secure_token
   
   GITHUB_ID=your_github_oauth_app_id
   GITHUB_SECRET=your_github_oauth_app_secret
   
   BYTEZ_API_KEY=your_ai_api_key
   
   # Optional (for rate limiting):
   # KV_REST_API_URL=your_upstash_redis_url
   # KV_REST_API_TOKEN=your_upstash_redis_token

4. Run the development server:

   npm run dev

   Visit http://localhost:3000 to start generating READMEs!

flowchart LR
    Client([User UI]) -->|GitHub Repo URL| API(Next.js API route)
    API <-->|OAuth JWT| Auth[NextAuth.js]
    API <-->|Rate Check| Redis[(Upstash KV)]
    
    API -->|Fetch Code Info| GithubAPI[GitHub REST Edge]
    GithubAPI --> API
    
    API -->|Prompt & Context| AI[Bytez/OpenAI Engine]
    AI -->|Strict Markdown| API
    
    API --> Client

• Least Privilege Auth: The GitHub OAuth app only requests read:user user:email public_repo scopes.
• Graceful Fallbacks: If Upstash Redis is not attached or configured, the application falls back gracefully, ensuring local development is frictionless.
• Strict Parsing Guardrails: The integration layer actively strips markdown artifacts, ensuring the output is perfectly raw, valid GitHub Markdown.

• Created with ❤️ by Suraj Dhawal.
• Licensed under the MIT License.