Skip to content

enoshdev/devdocs-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

🤖 DevDocs AI

Paste any Python function. Get instant explanation, docstring and improvement suggestions — powered by Groq LLaMA 3.1.

🔗 Live Demo

https://devdocs-ai.netlify.app

✨ Features

  • 💡 Plain English explanation of what your code does
  • 📄 Auto-generated Google-style docstring
  • ⚡ 3 specific numbered improvement suggestions
  • 📋 One-click copy for generated docstring
  • ⌨️ Ctrl + Enter keyboard shortcut

🛠 Tech Stack

Layer Technology
Backend Python, FastAPI
AI Groq API — LLaMA 3.1
Frontend HTML, CSS, JavaScript
Deployment Hugging Face Spaces + Netlify

🚀 Run Locally

Backend

cd backend
pip install -r requirements.txt
python -m uvicorn main:app --reload

Frontend

Open frontend/index.html with Live Server in VS Code.

📁 Project Structure

devdocs-ai/
  backend/
    main.py          # FastAPI app + Groq AI integration
    requirements.txt
    Dockerfile       # For Hugging Face deployment
  frontend/
    index.html       # Full UI with particle animations
  README.md

👨‍💻 Author

Built by G J Enosh — Information Technology student from Vasavi College of Engineering, Hyderabad , Telangana.

GitHub

About

AI-powered tool that explains Python code, generates docstrings, and suggests improvements using Groq LLaMA 3.1

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors