CODLE_AI / README.md
prajvalitha's picture
Update README.md
0f4ac15 verified
|
Raw
History Blame Contribute Delete
2.1 kB
---
title: CODLE AI
emoji: πŸ€–
colorFrom: purple
colorTo: blue
sdk: gradio
sdk_version: "5.35.0"
python_version: "3.11"
app_file: app.py
pinned: false
---
# πŸ€– Codle AI
> **AI-Powered Coding Mentor & Polyglot Code Translator**
...
# πŸ€– Codle AI Platform
A premium AI developer platform built with Python + Gradio. Explain, translate, visualize, and analyze code with a polished dark UI.
## Features
| Tab | Feature |
|-----|---------|
| πŸ” Explain | AI code explanation with bug detection, complexity analysis, ELI5 mode |
| πŸ”„ Translate | AI code translator across 9 languages with split-view output |
| πŸ“ˆ Complexity | Animated complexity dashboard with O() badges and growth curves |
## Setup
```powershell
# 1. Create a virtual environment (if not already created)
python -m venv venv
# 2. Install dependencies in the virtual environment
.\venv\Scripts\pip install -r requirements.txt
# 3. Configure your HF token
# Edit .env and replace the placeholder:
# HF_TOKEN=hf_your_token_here
# 4. Run the app
.\venv\Scripts\python.exe app.py
```
## Project Structure
```
code_explainer/
β”œβ”€β”€ app.py # Main Gradio application
β”œβ”€β”€ prompts.py # All AI prompt builders
β”œβ”€β”€ utils.py # Inference engine (secure, token-safe)
β”œβ”€β”€ .env # Your HF_TOKEN (never commit this)
β”œβ”€β”€ .gitignore
β”œβ”€β”€ requirements.txt
β”œβ”€β”€ assets/
β”‚ β”œβ”€β”€ logo.png
β”‚ β”œβ”€β”€ styles.css # Full premium dark theme
β”‚ └── codle.js # Particles, flow viz, chart, toasts, shortcuts
└── README.md
```
## Security
- `HF_TOKEN` is loaded only from the environment/`.env` file
- Never accepted from UI inputs or passed through Gradio state
- Never logged, printed, or returned to the frontend
- App aborts at startup if token is missing
## Keyboard Shortcuts
| Shortcut | Action |
|----------|--------|
| `Ctrl+Enter` | Analyze code |
| `Ctrl+K` | Clear editor |
| `Ctrl+S` | Download markdown report |
| `Ctrl+Shift+C` | Copy report to clipboard |
| `Ctrl+/` | Open command palette |