Skip to content

Latest commit

 

History

History

README.md

AI Council Documentation

This folder contains all important documentation for the AI Council project.

Quick Links

Project Structure

docs/
├── README.md                          # This file
├── QUICK_START.md                     # Quick start guide
├── SETUP_CHECKLIST.md                 # Setup checklist
├── TROUBLESHOOTING.md                 # Troubleshooting guide
├── IMPLEMENTATION_ROADMAP.md          # Development roadmap
├── PRODUCTION_DEPLOYMENT_PLAN.md      # Deployment guide
└── supabase-database-setup.sql        # Database schema

backend/docs/
├── API_KEYS_SETUP.md                  # API keys configuration
├── OLLAMA_SETUP.md                    # Ollama setup
├── GEMINI_SETUP.md                    # Gemini setup
├── HUGGINGFACE_SETUP.md               # HuggingFace setup
├── OPENROUTER_SETUP.md                # OpenRouter setup
├── TOGETHER_SETUP.md                  # Together AI setup
├── OPENAI_SETUP.md                    # OpenAI setup
├── QWEN_SETUP.md                      # Qwen setup
├── PROVIDER_CONFIGURATION.md          # Provider config
├── DYNAMIC_PROVIDER_SELECTION.md      # Dynamic provider selection
├── ORCHESTRATION_TEST_RESULTS.md      # Orchestration tests
├── PROVIDER_HEALTH_MONITORING.md      # Health monitoring
└── PROVIDER_COST_TRACKING.md          # Cost tracking

Getting Started

  1. Read the Quick Start Guide
  2. Follow the Setup Checklist
  3. Configure your environment variables
  4. Run the development servers
  5. Check Troubleshooting if you encounter issues

Development

  • Frontend: Next.js 14 with TypeScript
  • Backend: FastAPI with Python 3.11+
  • Database: Supabase (PostgreSQL)
  • Cache: Redis

Support

For issues and questions, refer to the Troubleshooting Guide.