something is kinda working

2025-12-13 05:41:13 +01:00
parent 955f992f8e
commit 1f313f090a
20 changed files with 390 additions and 349 deletions
--- a/web/README.md
+++ b/web/README.md
@@ -1,117 +1,104 @@
-# CopilotKit <> PydanticAI Starter
+# Cavepedia

-This is a starter template for building AI agents using [PydanticAI](https://ai.pydantic.dev/) and [CopilotKit](https://copilotkit.ai). It provides a modern Next.js application with an integrated investment analyst agent that can research stocks, analyze market data, and provide investment insights.
+A caving assistant built with [PydanticAI](https://ai.pydantic.dev/), [CopilotKit](https://copilotkit.ai), and Gemini.

 ## Prerequisites

- OpenAI API Key (for the PydanticAI agent)
- Python 3.12+
+- Google API Key (for Gemini)
+- Auth0 account with application configured
+- Python 3.13+
 - uv
- Node.js 20+ 
- Any of the following package managers:
-  - pnpm (recommended)
-  - npm
-  - yarn
-  - bun
+- Node.js 24+
+- npm

-> **Note:** This repository ignores lock files (package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb) to avoid conflicts between different package managers. Each developer should generate their own lock file using their preferred package manager. After that, make sure to delete it from the .gitignore.
+## Environment Variables

-## Getting Started
+### Web App (.env)

-1. Install dependencies using your preferred package manager:
+```
+AUTH0_SECRET=<random-secret>
+AUTH0_DOMAIN=<your-auth0-domain>
+AUTH0_CLIENT_ID=<your-client-id>
+AUTH0_CLIENT_SECRET=<your-client-secret>
+APP_BASE_URL=https://your-domain.com
+AGENT_URL=http://localhost:8000/
+```
+
+### Agent (agent/.env)
+
+```
+GOOGLE_API_KEY=<your-google-api-key>
+```
+
+## Development
+
+1. Install dependencies:
 ```bash
-# Using pnpm (recommended)
-pnpm install
-
-# Using npm
 npm install
-
-# Using yarn
-yarn install
-
-# Using bun
-bun install
 ```

-> **Note:** This will automatically setup the Python environment as well.
->
-> If you have manual isseus, you can run:
->
-> ```sh
-> npm run install:agent
-> ```
-
-
-3. Set up your OpenAI API key:
-
-Create a `.env` file inside the `agent` folder with the following content:
-
-```
-OPENAI_API_KEY=sk-...your-openai-key-here...
-```
-
-
-4. Start the development server:
+2. Start the development server:
 ```bash
-# Using pnpm
-pnpm dev
-
-# Using npm
 npm run dev
-
-# Using yarn
-yarn dev
-
-# Using bun
-bun run dev
 ```

-This will start both the UI and agent servers concurrently.
+This starts both the UI and agent servers concurrently.
+
+## Production
+
+### Docker Build
+
+**Web (Next.js):**
+```bash
+docker build -t cavepedia-web .
+docker run -p 3000:3000 \
+  -e AUTH0_SECRET=<secret> \
+  -e AUTH0_DOMAIN=<domain> \
+  -e AUTH0_CLIENT_ID=<client-id> \
+  -e AUTH0_CLIENT_SECRET=<client-secret> \
+  -e APP_BASE_URL=https://your-domain.com \
+  -e AGENT_URL=http://agent:8000/ \
+  cavepedia-web
+```
+
+**Agent (PydanticAI):**
+```bash
+cd agent
+docker build -t cavepedia-agent .
+docker run -p 8000:8000 \
+  -e GOOGLE_API_KEY=<api-key> \
+  cavepedia-agent
+```
+
+### Without Docker
+
+```bash
+npm run build
+npm run start:all
+```

 ## Available Scripts
-The following scripts can also be run using your preferred package manager:
+
 - `dev` - Starts both UI and agent servers in development mode
- `dev:debug` - Starts development servers with debug logging enabled
 - `dev:ui` - Starts only the Next.js UI server
 - `dev:agent` - Starts only the PydanticAI agent server
 - `build` - Builds the Next.js application for production
- `start` - Starts the production server
- `lint` - Runs ESLint for code linting
- `install:agent` - Installs Python dependencies for the agent
-
-## Documentation
-
-The main UI component is in `src/app/page.tsx`. You can:
- Modify the theme colors and styling
- Add new frontend actions
- Customize the CopilotKit sidebar appearance
-
-## 📚 Documentation
-
- [PydanticAI Documentation](https://ai.pydantic.dev) - Learn more about PydanticAI and its features
- [CopilotKit Documentation](https://docs.copilotkit.ai) - Explore CopilotKit's capabilities
- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API
-
-## Contributing
-
-Feel free to submit issues and enhancement requests! This starter is designed to be easily extensible.
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details.
+- `start` - Starts the production Next.js server
+- `start:agent` - Starts the production agent server
+- `start:all` - Starts both servers in production mode
+- `lint` - Runs ESLint

 ## Troubleshooting

 ### Agent Connection Issues
-If you see "I'm having trouble connecting to my tools", make sure:
-1. The PydanticAI agent is running on port 8000
-2. Your OpenAI API key is set correctly
-3. Both servers started successfully
+If you see connection errors:
+1. Ensure the agent is running on port 8000
+2. Check that GOOGLE_API_KEY is set correctly
+3. Verify AGENT_URL has a trailing slash

 ### Python Dependencies
-If you encounter Python import errors:
 ```bash
 cd agent
 uv sync
-uv run src/main.py
-```
+uv run uvicorn src.main:app --host 127.0.0.1 --port 8000
+```