Skip to content

Commit 84a3733

Browse files
committed
README.md 및 Vercel 배포 가이드 업데이트: 빠른 시작 섹션 추가 및 배포 단계 간소화
1 parent 90d72ae commit 84a3733

File tree

2 files changed

+40
-51
lines changed

2 files changed

+40
-51
lines changed

README.md

Lines changed: 10 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@
1313
- **MCP Tools Demo:** [Chat with Tools](https://better-chatbot-demo.vercel.app/export/a4820921-8012-496b-8a5d-13757050bafe)
1414
- **Image Generation Demo:** [Chat with Image Generation](https://better-chatbot-demo.vercel.app/export/452ad745-9efb-49ae-9114-10db15f1b827)
1515

16+
## Quick Start 🚀
17+
18+
> **Get your app running in minutes! No installation or payment required.**
19+
20+
You only need **one AI Provider API Key** (OpenAI, Claude, Gemini, etc.). Everything else runs on free tiers - database, file storage, and hosting.
21+
22+
👉 **[Click this guide to deploy your site with just a few clicks](docs/tips-guides/vercel.md)**
23+
24+
---
25+
1626
**Better Chatbot** - A better open-source AI chatbot for individuals and teams, inspired by ChatGPT, Claude, Grok, and Gemini.
1727

1828
**Multi-AI Support** - Integrates all major LLMs: OpenAI, Anthropic, Google, xAI, Ollama, and more
@@ -26,45 +36,6 @@
2636

2737
Built with Vercel AI SDK and Next.js, combining the best features of leading AI services into one platform.
2838

29-
### Quick Start 🚀
30-
31-
```bash
32-
# 1. Clone the repository
33-
34-
git clone https://github.com/cgoinglove/better-chatbot.git
35-
cd better-chatbot
36-
37-
# 2. (Optional) Install pnpm if you don't have it
38-
39-
npm install -g pnpm
40-
41-
# 3. Install dependencies
42-
43-
pnpm i
44-
45-
# 4. (Optional) Start a local PostgreSQL instance
46-
47-
pnpm docker:pg
48-
49-
# If you already have your own PostgreSQL running, you can skip this step.
50-
# In that case, make sure to update the PostgreSQL URL in your .env file.
51-
52-
# 5. Enter required information in the .env file
53-
54-
# The .env file is created automatically. Just fill in the required values.
55-
# For the fastest setup, provide at least one LLM provider's API key (e.g., OPENAI_API_KEY, CLAUDE_API_KEY, GEMINI_API_KEY, etc.) and the PostgreSQL URL you want to use.
56-
57-
# 6. Start the server
58-
59-
pnpm build:local && pnpm start
60-
61-
# (Recommended for most cases. Ensures correct cookie settings.)
62-
# For development mode with hot-reloading and debugging, you can use:
63-
# pnpm dev
64-
```
65-
66-
Open [http://localhost:3000](http://localhost:3000) in your browser to get started.
67-
6839
## Table of Contents
6940

7041
- [Table of Contents](#table-of-contents)

docs/tips-guides/vercel.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,53 @@
11
# Vercel Deployment Guide
22

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+
311
1. **Click this button** to start the deployment process:
4-
[![Deploy with Vercel](https://vercel.com/button)](<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+
[![Deploy with Vercel](https://vercel.com/button)](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}])
513

614
2. **Click the "Create" button** on Vercel to begin setting up your project.
715

816
<img width="1254" alt="step2" src="https://github.com/user-attachments/assets/66806fa8-2d55-4e57-ad7e-2f37ef037a97" />
917

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.
1225

1326
<img width="1329" alt="step3" src="https://github.com/user-attachments/assets/d0f3848e-e45b-4c20-843e-7c452c297e51" />
1427

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.**
1729

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.
1933

2034
<img width="1469" alt="step4" src="https://github.com/user-attachments/assets/a0ca9aab-e32a-42ff-8714-707cda387c2a" />
2135

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.
2438

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.
2741

2842
- 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.
2944

3045
<img width="1712" alt="step6" src="https://github.com/user-attachments/assets/2d197389-a865-46ac-9156-40cad64258ca" />
3146

47+
---
48+
3249
## Notes
3350

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

Comments
 (0)