Skip to content

adithyaharish/DocuGen_UI_Backup

Repository files navigation

📘 DocuGen – AI-Powered Documentation Generator

DocuGen is a fullstack web app that generates intelligent documentation for GitHub repositories based on selected personas (Beginner, Intermediate, Expert). It also supports real-time chat-based refinement of generated docs using GPT.

🛠 Tech Stack

  • Frontend: React (inside src/)
  • Backend: Express (servernew.js)
  • ML Service: Calls a hosted API to extract summaries from GitHub code
  • AI: OpenAI GPT-4 (via /generate-docs and /chat routes)

🚀 Main Features

  • Submit any public GitHub repo URL
  • Choose your learning persona
  • Get contextual project documentation
  • Chat with the AI to refine/clarify the docs
  • Get a SetUp Guide to help you run the code locally
  • Compare branches and their differences in a repo

📂 Code Overview

  • servernew.js: Main Express backend file (routes, GPT & ML API calls)
  • src/: All React components and logic
  • App.js: Core frontend logic – UI layout, API calls, chat interface
  • public/: Static HTML template and assets
  • build/: Auto-generated production build (served via Express)

🌐 Deployment Notes

  • Backend and frontend are served from the same Render app
  • All fetch() calls use relative paths like /generate-docs
  • Static React app is served using js:

1. To Run Locally

npm install
npm run build
npm start
node servernew.js

Live at:

https://docugen-app.onrender.com/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors