mirror of
https://github.com/thecyberlearn/quantum-ai-v3.git
synced 2026-08-18 10:12:58 +00:00
| .github/workflows | ||
| agent_base | ||
| authentication | ||
| core | ||
| data_analyzer | ||
| docs | ||
| email_writer | ||
| five_whys_analyzer | ||
| job_posting_generator | ||
| netcop_hub | ||
| social_ads_generator | ||
| static | ||
| templates | ||
| tests | ||
| wallet | ||
| weather_reporter | ||
| .env.example | ||
| .env.production.template | ||
| .gitignore | ||
| agent_template_prototype.html | ||
| CLAUDE.md | ||
| deploy_n8n_workflows.sh | ||
| manage_n8n_workflows.py | ||
| manage.py | ||
| railway.json | ||
| requirements-dev.txt | ||
| requirements.txt | ||
| run_dev.sh | ||
| social_ads_generator_exact_ui.html | ||
| social_ads_generator_exact.html | ||
| social_ads_generator.html | ||
📚 Quantum Tasks AI Documentation
Welcome to the comprehensive documentation for Quantum Tasks AI - a Django-based AI agent marketplace platform.
🚀 Quick Start
- New to the project? Start with Local Development Setup
- Deploying to production? See Railway Deployment Guide
- Changing domains? Follow Domain Change Guide
- Building agents? Check Agent Creation Guide
📂 Documentation Structure
🛠️ Development
Documentation for local development and agent creation.
| Document | Description |
|---|---|
| Setup Guide | Local development environment setup |
| Agent Creation | Building new AI agents for the platform |
| Testing Guide | Testing procedures and best practices |
🚀 Deployment
Production deployment and configuration guides.
| Document | Description |
|---|---|
| Railway Deployment | Complete Railway.app deployment guide |
| Domain Change Guide | Step-by-step domain change instructions |
| Environment Variables | Complete environment configuration reference |
⚙️ Operations
System maintenance, troubleshooting, and operations.
| Document | Description |
|---|---|
| Database Management | Database operations and maintenance |
| Troubleshooting | Common issues and solutions |
| Maintenance | System maintenance procedures |
🏗️ Architecture Overview
Core Components:
- 🌐 Django Application - Main web platform
- 🗄️ PostgreSQL Database - User data and transactions
- 🔄 Redis Cache - Session storage and performance
- 🤖 AI Agents - Specialized AI tools for users
- 💳 Stripe Integration - Payment processing
- 📧 Email System - User notifications and verification
Agent Architecture:
- API Agents - Direct API integration (e.g., Weather Reporter)
- Webhook Agents - External N8N workflow processing (e.g., Data Analyzer)
📋 Essential Information
🔧 System Requirements
Development:
- Python 3.8+
- Django 5.2+
- SQLite (default) or PostgreSQL
- Redis (optional)
Production:
- Railway.app account
- PostgreSQL database
- Redis cache
- SMTP email service
- Stripe account
🌍 Environment Types
| Environment | Database | Cache | Purpose | |
|---|---|---|---|---|
| Local Dev | SQLite | Memory | Console | Development and testing |
| Railway Staging | PostgreSQL | Redis | SMTP | Pre-production testing |
| Railway Production | PostgreSQL | Redis | SMTP | Live application |
🔗 Key URLs
Development:
- Application:
http://localhost:8000 - Admin:
http://localhost:8000/admin/ - Health Check:
http://localhost:8000/health/
Production:
- Application:
https://quantum-ai.up.railway.app - Admin:
https://quantum-ai.up.railway.app/admin/ - Health Check:
https://quantum-ai.up.railway.app/health/
🚨 Emergency Procedures
Quick Fixes
Application Won't Start:
- Check Troubleshooting Guide
- Verify Environment Variables
- Test database connection:
python manage.py check --database default
Domain Issues:
- Follow Domain Change Guide
- Update
ALLOWED_HOSTSandCSRF_TRUSTED_ORIGINS - Test with health check endpoint
Database Problems:
- See Database Management
- Check Railway PostgreSQL service status
- Verify
DATABASE_URLenvironment variable
Support Commands
# Check system health
python manage.py check --deploy
# Test database connection
python manage.py check_db
# Create admin user
python manage.py check_admin
# Test email functionality
python manage.py shell
>>> from django.core.mail import send_mail
>>> send_mail('Test', 'Message', 'from@example.com', ['to@example.com'])
🔍 Finding Information
📖 By Task
| What do you want to do? | Go to |
|---|---|
| Set up local development | Setup Guide |
| Deploy to production | Railway Deployment |
| Change domain/URL | Domain Change Guide |
| Configure environment | Environment Variables |
| Create new AI agent | Agent Creation |
| Fix database issues | Database Management |
| Solve common problems | Troubleshooting |
📖 By Component
| Component | Documentation |
|---|---|
| Django App | Setup Guide, Railway Deployment |
| Database | Database Management, Environment Variables |
| AI Agents | Agent Creation |
| Email System | Environment Variables, Troubleshooting |
| Payments | Environment Variables |
🆘 Getting Help
Documentation Issues
- 📝 Found outdated information? Check if there's a newer version
- 🔍 Can't find what you need? Check the Troubleshooting Guide
- 📧 Still stuck? Review error logs and environment configuration
Development Questions
- 🧪 Testing issues? See Testing Guide
- 🤖 Agent development? Check Agent Creation
- 🔧 Environment setup? Follow Setup Guide
Production Issues
- 🚀 Deployment problems? See Railway Deployment
- 🌐 Domain/DNS issues? Follow Domain Change Guide
- 🗄️ Database problems? Check Database Management
📅 Documentation Updates
This documentation is updated regularly. Key sections:
- Environment Variables - Updated with new integrations
- Deployment Guides - Updated for new Railway features
- Troubleshooting - Updated with new common issues
- Agent Creation - Updated with new agent types
Last Major Update: December 2024
Current Version: Django 5.2, Python 3.8+, Railway.app deployment
🎯 Pro Tip: Bookmark this page and the Quick Start section for fast access to essential guides!