File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Changelog
2+
3+ All notable changes will be documented in this file.
4+
5+ ## [ 1.0.0] - 2026-03-30
6+ ### Added
7+ - Initial release
8+ - Gradio web interface
9+ - Docker support
10+ - GitHub Actions CI/CD
11+ - Test suite
12+ - Documentation
Original file line number Diff line number Diff line change 1+ # Contributor Covenant Code of Conduct
2+
3+ ## Our Pledge
4+ We pledge to make participation in our project a harassment-free experience for everyone.
5+
6+ ## Our Standards
7+ Examples of behavior that contributes to a positive environment:
8+ - Using welcoming and inclusive language
9+ - Being respectful of differing viewpoints
10+ - Focusing on what is best for the community
11+
12+ ## Enforcement
13+ Instances of unacceptable behavior may be reported to the project maintainers.
Original file line number Diff line number Diff line change 1+ # Security Policy
2+
3+ ## Supported Versions
4+ | Version | Supported |
5+ | ------- | ---------- |
6+ | 1.x | ✅ |
7+
8+ ## Reporting a Vulnerability
9+ If you discover a security vulnerability, please report it via:
10+ - GitHub Issues (private)
11+ - Email: walid.sobhie@gmail.com
12+
13+ Please do not disclose publicly until we have addressed it.
Original file line number Diff line number Diff line change 1+ version : ' 3.8'
2+
3+ services :
4+ app :
5+ build : .
6+ ports :
7+ - " 7860:7860"
8+ environment :
9+ - OPENAI_API_KEY=${OPENAI_API_KEY}
10+ volumes :
11+ - ./data:/app/data
12+ restart : unless-stopped
Original file line number Diff line number Diff line change 1+ # Examples
2+
3+ Example usage scripts and demos.
4+
5+ ## Getting Started
6+ ``` bash
7+ python3 examples/basic_example.py
8+ ```
Original file line number Diff line number Diff line change 1+ #! /bin/bash
2+ # Quick Install Script
3+
4+ set -e
5+
6+ echo " 🚀 Installing..."
7+
8+ # Check Python version
9+ python3 --version || { echo " Python 3 required" ; exit 1; }
10+
11+ # Create virtual environment
12+ python3 -m venv venv
13+ source venv/bin/activate
14+
15+ # Install dependencies
16+ pip install --upgrade pip
17+ pip install -r requirements.txt
18+
19+ # Copy environment file
20+ if [ ! -f .env ]; then
21+ cp .env.example .env
22+ echo " ⚠️ Please edit .env with your API keys"
23+ fi
24+
25+ echo " ✅ Installation complete!"
26+ echo " Run: source venv/bin/activate && python gradio_app.py"
You can’t perform that action at this time.
0 commit comments