{"repo": "abelhubprog/handywriterzai", "files": {"SETUP.md": {"2bd1d34fb411c12e9ac3ee3c3fccce86f4d66eaa": {"t": 1785747216.6632187, "n": 2593, "h": "21027e45a5d2ba87", "c": "# Setup Guide\r\n\r\nThis document provides detailed instructions for setting up the development environment for the Multi-Agent AI Platform.\r\n\r\n## Prerequisites\r\n\r\nBefore you begin, ensure you have the following installed on your system:\r\n\r\n*   **Python 3.11+**\r\n*   **Node.js 18+** and **npm**\r\n*   **PostgreSQL**\r\n*   **Redis**\r\n*   **Docker** and **Docker Compose** (for production deployment)\r\n\r\n## 1. Clone the Repository\r\n\r\n```bash\r\ngit clone https://github.com/your-org/multiagent-platform.git\r\ncd multiagent-platform\r\n```\r\n\r\n## 2. Configure Environment Variables\r\n\r\nThe application requires a number of environment variables to be set, including API keys for the various AI providers.\r\n\r\n1.  **Copy the example environment file:**\r\n\r\n    ```bash\r\n    cp backend/backend/.env.example backend/backend/.env\r\n    ```\r\n\r\n2.  **Edit the `.env` file:**\r\n\r\n    Open the `backend/backend/.env` file and fill in the required values for the following variables:\r\n\r\n    *   `GEMINI_API_KEY`\r\n    *   `ANTHROPIC_API_KEY`\r\n    *   `OPENAI_API_KEY`\r\n    *   `PERPLEXITY_API_KEY`\r\n    *   `DEEPSEEK_API_KEY`\r\n    *   `QWEN_API_KEY`\r\n    *   `GROK_API_KEY`\r\n    *   `GITHUB_TOKEN`\r\n    *   `DATABASE_URL`\r\n    *   `REDIS_URL`\r\n    *   `SUPABASE_URL`\r\n    *   `SUPABASE_KEY`\r\n    *   `JWT_SECRET_KEY`\r\n    *   ...and so on for all the variables in the file.\r\n\r\n## 3. Run the Setup Script\r\n\r\nThe `setup.sh` script automates the process of setting up the Python virtual environment, installing dependencies, and configuring the database.\r\n\r\n```bash\r\ncd backend/backend\r\n./scripts/setup.sh\r\n```\r\n\r\nThis script will:\r\n\r\n*   Create a Python virtual environment in `.venv/`.\r\n*   Install all the required Python dependencies from `requirements.txt`.\r\n*   Create the `handywriterz` PostgreSQL database if it doesn't already exist.\r\n*   Enable the `pgvector` extension in the database.\r\n*   Start the Redis server if it's not already running.\r\n*   Run the Alembic database migrations to create the necessary tables.\r\n\r\n## 4. Start the Application\r\n\r\nOnce the setup is complete, you can start the application using the following commands:\r\n\r\n### Backend\r\n\r\n```bash\r\ncd backend/backend\r\nuvicorn src.main:app --reload\r\n```\r\n\r\n### Frontend\r\n\r\n```bash\r\ncd frontend\r\nnpm install\r\nnpm run dev\r\n```\r\n\r\nThe application will be available at `http://localhost:5173`.\r\n\r\n## 5. Production Deployment\r\n\r\nFor production deployment, you can use the provided Docker Compose files.\r\n\r\n```bash\r\ndocker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d\r\n```\r\n\r\nThis will start all the necessary services in detached mode."}, "c150303545119e9eee1237596435095f345a6ede": {"t": 1785771433.3682537, "n": 2593, "h": "21027e45a5d2ba87", "c": "# Setup Guide\r\n\r\nThis document provides detailed instructions for setting up the development environment for the Multi-Agent AI Platform.\r\n\r\n## Prerequisites\r\n\r\nBefore you begin, ensure you have the following installed on your system:\r\n\r\n*   **Python 3.11+**\r\n*   **Node.js 18+** and **npm**\r\n*   **PostgreSQL**\r\n*   **Redis**\r\n*   **Docker** and **Docker Compose** (for production deployment)\r\n\r\n## 1. Clone the Repository\r\n\r\n```bash\r\ngit clone https://github.com/your-org/multiagent-platform.git\r\ncd multiagent-platform\r\n```\r\n\r\n## 2. Configure Environment Variables\r\n\r\nThe application requires a number of environment variables to be set, including API keys for the various AI providers.\r\n\r\n1.  **Copy the example environment file:**\r\n\r\n    ```bash\r\n    cp backend/backend/.env.example backend/backend/.env\r\n    ```\r\n\r\n2.  **Edit the `.env` file:**\r\n\r\n    Open the `backend/backend/.env` file and fill in the required values for the following variables:\r\n\r\n    *   `GEMINI_API_KEY`\r\n    *   `ANTHROPIC_API_KEY`\r\n    *   `OPENAI_API_KEY`\r\n    *   `PERPLEXITY_API_KEY`\r\n    *   `DEEPSEEK_API_KEY`\r\n    *   `QWEN_API_KEY`\r\n    *   `GROK_API_KEY`\r\n    *   `GITHUB_TOKEN`\r\n    *   `DATABASE_URL`\r\n    *   `REDIS_URL`\r\n    *   `SUPABASE_URL`\r\n    *   `SUPABASE_KEY`\r\n    *   `JWT_SECRET_KEY`\r\n    *   ...and so on for all the variables in the file.\r\n\r\n## 3. Run the Setup Script\r\n\r\nThe `setup.sh` script automates the process of setting up the Python virtual environment, installing dependencies, and configuring the database.\r\n\r\n```bash\r\ncd backend/backend\r\n./scripts/setup.sh\r\n```\r\n\r\nThis script will:\r\n\r\n*   Create a Python virtual environment in `.venv/`.\r\n*   Install all the required Python dependencies from `requirements.txt`.\r\n*   Create the `handywriterz` PostgreSQL database if it doesn't already exist.\r\n*   Enable the `pgvector` extension in the database.\r\n*   Start the Redis server if it's not already running.\r\n*   Run the Alembic database migrations to create the necessary tables.\r\n\r\n## 4. Start the Application\r\n\r\nOnce the setup is complete, you can start the application using the following commands:\r\n\r\n### Backend\r\n\r\n```bash\r\ncd backend/backend\r\nuvicorn src.main:app --reload\r\n```\r\n\r\n### Frontend\r\n\r\n```bash\r\ncd frontend\r\nnpm install\r\nnpm run dev\r\n```\r\n\r\nThe application will be available at `http://localhost:5173`.\r\n\r\n## 5. Production Deployment\r\n\r\nFor production deployment, you can use the provided Docker Compose files.\r\n\r\n```bash\r\ndocker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d\r\n```\r\n\r\nThis will start all the necessary services in detached mode."}}}}