|
| 1 | +# CodeLens. Deployment Guide (Production) |
| 2 | + |
| 3 | +Follow this guide to deploy **CodeLens. v1.0.0** to the professional cloud. This configuration uses **Vercel** for the frontend, **Render** for the backend, and **Supabase/Neon** for the PostgreSQL database. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 1. 🗄️ Setup the Database (PostgreSQL) |
| 8 | + |
| 9 | +Since SQLite is disk-based and will be deleted at every restart on Render/Vercel, you **must** use a managed PostgreSQL service. |
| 10 | + |
| 11 | +1. **Go to [Supabase](https://supabase.com)** or [Neon](https://neon.tech). |
| 12 | +2. **Create a new Project** called "CodeLens". |
| 13 | +3. **Copy your Connection String** (it should look like `postgres://user:pass@host:5432/dbname`). |
| 14 | +4. **Important**: Keep this URL safe—it is your `DATABASE_URL`. |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## 2. 🚀 Setup the Backend (Render) |
| 19 | + |
| 20 | +Render will host your FastAPI API and your Dockerized environment. |
| 21 | + |
| 22 | +1. **Go to [Render Dashboard](https://dashboard.render.com)**. |
| 23 | +2. **New -> Web Service** and connect your GitHub repository. |
| 24 | +3. **Configure**: |
| 25 | + - **Runtime**: `Docker`. |
| 26 | + - **Environment Variables**: |
| 27 | + - `DATABASE_URL`: (Paste your Supabase/Neon URL here). |
| 28 | + - `API_KEY_ENABLED`: `true` (highly recommended for production). |
| 29 | + - `API_KEY`: A strong secret password. |
| 30 | + - `APP_ENV`: `production`. |
| 31 | +4. **Deploy**: Render will automatically build the `Dockerfile` in the root and start the service. |
| 32 | +5. **Identify**: Copy your Render URL (e.g., `https://codelens-api.onrender.com`). |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## 3. 🎨 Setup the Frontend (Vercel) |
| 37 | + |
| 38 | +Vercel will host your React/Vite dashboard. |
| 39 | + |
| 40 | +1. **Go to [Vercel](https://vercel.com)**. |
| 41 | +2. **Import** your `dashboard` folder (or the whole repository and set the root directory to `dashboard`). |
| 42 | +3. **Update `vercel.json`**: |
| 43 | + - Open [`dashboard/vercel.json`](file:///Users/arshverma/GitHub/open-ev-code-handler/dashboard/vercel.json). |
| 44 | + - Replace `https://YOUR_BACKEND_URL.render.com` with your **real** Render URL. |
| 45 | +4. **Deploy**: Vercel will build the React application and provide a global dashboard link. |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +## 4. 🤖 Running Remote Evaluations |
| 50 | + |
| 51 | +Once deployed, you can run the benchmark script from your local machine (or any CI) against your **production** instance: |
| 52 | + |
| 53 | +```bash |
| 54 | +python scripts/evaluate.py --url https://your-render-url.com --api-key YOUR_SECRET_KEY |
| 55 | +``` |
| 56 | + |
| 57 | +--- |
| 58 | + |
| 59 | +> [!CAUTION] |
| 60 | +> **Database Migrations**: When you first deploy to a new PostgreSQL instance, the tables will be empty. The first request to the API will automatically trigger `create_db_and_tables()` via the lifespan hook—no manual SQL is required. |
| 61 | +
|
| 62 | +> [!TIP] |
| 63 | +> **Vercel Rewrites**: The `vercel.json` rewrite rule is what allows the frontend to talk to the backend without CORS issues. Ensure the URL is exactly correct. |
0 commit comments