|
1 | 1 | # Vercel Deployment Guide |
2 | 2 |
|
| 3 | +The easiest way to get started with **better-chatbot** is to deploy it directly to Vercel. |
| 4 | +You only need **one AI Provider API Key** (OpenAI, Gemini, Claude, etc.) to run the app. |
| 5 | +Database, file storage, and caching are all available on free tiers. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Steps |
| 10 | + |
3 | 11 | 1. **Click this button** to start the deployment process: |
4 | | - [](<https://vercel.com/new/clone?repository-url=https://github.com/cgoinglove/better-chatbot&env=BETTER_AUTH_SECRET&env=OPENAI_API_KEY&env=GOOGLE_GENERATIVE_AI_API_KEY&env=ANTHROPIC_API_KEY&envDescription=BETTER_AUTH_SECRET+is+required+(enter+any+secret+value).+At+least+one+LLM+provider+API+key+(OpenAI,+Claude,+or+Google)+is+required,+but+you+can+add+all+of+them.+See+the+link+below+for+details.&envLink=https://github.com/cgoinglove/better-chatbot/blob/main/.env.example&demo-title=better-chatbot&demo-description=An+Open-Source+Chatbot+Template+Built+With+Next.js+and+the+AI+SDK+by+Vercel.&products=[{"type":"integration","protocol":"storage","productSlug":"neon","integrationSlug":"neon"},{"type":"integration","protocol":"storage","productSlug":"upstash-kv","integrationSlug":"upstash"},{"type":"blob"}]>) |
| 12 | + [](https://vercel.com/new/clone?repository-url=https://github.com/cgoinglove/better-chatbot&env=BETTER_AUTH_SECRET&env=OPENAI_API_KEY&env=GOOGLE_GENERATIVE_AI_API_KEY&env=ANTHROPIC_API_KEY&envDescription=BETTER_AUTH_SECRET+is+required+%28enter+any+secret+value%29.+At+least+one+LLM+provider+API+key+%28OpenAI,+Claude,+or+Google%29+is+required,+but+you+can+add+all+of+them.+See+the+link+below+for+details.&envLink=https://github.com/cgoinglove/better-chatbot/blob/main/.env.example&demo-title=better-chatbot&demo-description=An+Open-Source+Chatbot+Template+Built+With+Next.js+and+the+AI+SDK+by+Vercel.&products=[{%22type%22:%22integration%22,%22protocol%22:%22storage%22,%22productSlug%22:%22neon%22,%22integrationSlug%22:%22neon%22},{%22type%22:%22integration%22,%22protocol%22:%22storage%22,%22productSlug%22:%22upstash-kv%22,%22integrationSlug%22:%22upstash%22},{%22type%22:%22blob%22}]) |
5 | 13 |
|
6 | 14 | 2. **Click the "Create" button** on Vercel to begin setting up your project. |
7 | 15 |
|
8 | 16 | <img width="1254" alt="step2" src="https://github.com/user-attachments/assets/66806fa8-2d55-4e57-ad7e-2f37ef037a97" /> |
9 | 17 |
|
10 | | -3. **Add Neon Postgres and create a database.** |
11 | | - Click the "Neon Postgres Add" button to create a database. This is available even on the free plan. |
| 18 | +3. **Add all required resources.** |
| 19 | + When prompted, add: |
| 20 | + |
| 21 | + - **Database (Neon Postgres)** |
| 22 | + - **Blob Storage (Vercel Blob)** |
| 23 | + - **Redis (Upstash KV)** |
| 24 | + All of these are available with free-tier plans. |
12 | 25 |
|
13 | 26 | <img width="1329" alt="step3" src="https://github.com/user-attachments/assets/d0f3848e-e45b-4c20-843e-7c452c297e51" /> |
14 | 27 |
|
15 | | -4. **Add Environment Variables.** |
16 | | - You can enter placeholder values for the environment variables at this stage, or use the actual values if you have them ready. If you prefer, you can enter temporary values now and update them later in the project's settings after deployment is complete. However, **BETTER_AUTH_SECRET** must be set at this stage. |
| 28 | +4. **Set Environment Variables.** |
17 | 29 |
|
18 | | - - You can generate an BETTER_AUTH_SECRET [here](https://auth-secret-gen.vercel.app/). |
| 30 | + - You must enter a value for **BETTER_AUTH_SECRET** (any random string is fine). You can generate one [here](https://auth-secret-gen.vercel.app/). |
| 31 | + - Enter your **AI Provider API Key(s)**. Only one is required to start (OpenAI, Google Gemini, or Anthropic Claude). |
| 32 | + - You can use placeholder values and update them later in **Project Settings > Environments** after deployment. |
19 | 33 |
|
20 | 34 | <img width="1469" alt="step4" src="https://github.com/user-attachments/assets/a0ca9aab-e32a-42ff-8714-707cda387c2a" /> |
21 | 35 |
|
22 | | -5. **Deployment and Project Creation.** |
23 | | - Once the above steps are complete, deployment will begin automatically and your project will be created. |
| 36 | +5. **Deploy your project.** |
| 37 | + Once everything is set, Vercel will automatically build and deploy your project. |
24 | 38 |
|
25 | | -6. **Enter LLM Provider API Keys in Project Settings.** |
26 | | - After deployment, go to your project's **Settings > Environments** tab. Here, enter the API keys for the LLM providers you wish to use. You only need to enter the keys for the providers you actually plan to use—other fields can be left blank or filled with dummy values. |
| 39 | +6. **Update API Keys and Settings (optional).** |
| 40 | + After deployment, go to **Settings > Environments** to add or update your API keys and configuration. |
27 | 41 |
|
28 | 42 | - Example environment file: [example.env](https://github.com/cgoinglove/better-chatbot/blob/main/.env.example) |
| 43 | + - You can customize authentication, signup/login, and other options by editing your environment variables here. |
29 | 44 |
|
30 | 45 | <img width="1712" alt="step6" src="https://github.com/user-attachments/assets/2d197389-a865-46ac-9156-40cad64258ca" /> |
31 | 46 |
|
| 47 | +--- |
| 48 | + |
32 | 49 | ## Notes |
33 | 50 |
|
34 | | -- Only Remote(sse, streamable) MCP servers are supported (STDIO-based servers are not). |
35 | | -- If you need STDIO support, consider using Docker or Render. |
| 51 | +- To enable **web search**, you can request an API key from [Exa](https://dashboard.exa.ai). A free tier is available. |
| 52 | +- Only Remote (SSE, Streamable) MCP servers are supported. STDIO-based servers are not supported on Vercel (consider Docker or Render if needed). |
| 53 | +- Check `.env.example` for all available settings. |
0 commit comments