Installation
How to install and set up the Just-Use-Convex platform
Installation
This project uses a Turborepo monorepo structure with Bun as the package manager.
Prerequisites
Before you begin, ensure you have:
- Bun v1.3.6 or later
- A Convex account (free tier available)
- A Cloudflare account for agent deployment (optional for local dev)
Quick Start
1. Clone the Repository
git clone https://github.com/mantrakp04/just-use-convex.git
cd just-use-convex2. Install Dependencies
bun install3. Set Up Convex
Run the setup command and follow the prompts to create a new Convex project:
bun run dev:setup4. Configure Environment Variables
Set the required environment variables in Convex:
cd packages/backend
bunx convex env set BETTER_AUTH_SECRET=$(openssl rand -base64 32)
bunx convex env set SITE_URL http://localhost:3001
bunx convex run auth:getLatestJwks | bunx convex env set JWKSSet the following environment variables in apps/web/.env:
VITE_CONVEX_URL=https://your-project.convex.cloud
VITE_CONVEX_SITE_URL=https://your-project.convex.site
VITE_AGENT_URL=http://localhost:13375. Configure Agent Environment
Create packages/agent/.dev.vars with the following:
# packages/agent/.dev.vars
OPENROUTER_API_KEY=your-key
CONVEX_URL=https://your-project.convex.cloud
CONVEX_SITE_URL=https://your-project.convex.site
SITE_URL=http://localhost:3001
EXTERNAL_TOKEN=meow
DAYTONA_API_KEY=your-key # Optional: for sandbox features
EXA_API_KEY=your-key # Optional: for web search6. Start Development Server
bun run devOpen http://localhost:3001 in your browser.
Available Scripts
| Command | Description |
|---|---|
bun run dev | Start all apps (frontend + backend + agent) |
bun run dev:web | Start only the web application |
bun run dev:server | Start only the Convex backend |
bun run dev:setup | Setup and configure Convex project |
bun run check-types | TypeScript type checking across all packages |
One-Click Deploy
Deploy directly to Vercel with all environment variables pre-configured:
Next Steps
- Read the Introduction to understand the platform architecture
- Explore the Project Structure to navigate the codebase
- Learn about Authentication to understand the auth flow
- Check out the agent docs to understand AI integration and sandbox execution