https://github.com/anantgarg/chatbot-builder
Chatbot Builder
https://github.com/anantgarg/chatbot-builder
ai chatbot chatgpt openai
Last synced: 27 days ago
JSON representation
Chatbot Builder
- Host: GitHub
- URL: https://github.com/anantgarg/chatbot-builder
- Owner: anantgarg
- Created: 2025-02-04T09:08:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-15T13:50:08.000Z (about 1 year ago)
- Last Synced: 2025-05-15T14:45:26.310Z (about 1 year ago)
- Topics: ai, chatbot, chatgpt, openai
- Language: TypeScript
- Homepage: https://chatbot-builder-test.vercel.app
- Size: 260 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chatbot Builder
A modern platform for creating and managing AI-powered chatbots with OpenAI integration. Build custom chatbots with file-based knowledge and optional CometChat integration for real-time communication.
## ✨ Features
- 🤖 Create and manage multiple AI-powered chatbots
- 📚 Upload files to enhance your bot's knowledge base
- 🔍 Vector search for accurate and contextual responses
- 💬 Optional CometChat integration for real-time chat capabilities
- 🔒 Secure user authentication system
- 🔑 User-specific OpenAI API keys for privacy and billing control
## 🚀 Deployment on Vercel
### Prerequisites
- [Vercel account](https://vercel.com/signup)
- [GitHub account](https://github.com/signup)
- [Neon PostgreSQL database](https://neon.tech) (or any PostgreSQL provider)
### One-Click Deploy
Deploy directly to Vercel with one click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fyour-username%2Fchatbot-builder)
### Manual Deployment Steps
1. **Fork the repository**
Fork this repository to your GitHub account.
2. **Set up Neon PostgreSQL database**
- Sign up for a [Neon account](https://neon.tech)
- Create a new project
- Create a new database (e.g., "chatbotdb")
- Go to the "Connection Details" tab
- Copy the connection string (it should look like `postgres://user:password@endpoint/neondb`)
3. **Create a new Vercel project**
- Go to [Vercel Dashboard](https://vercel.com/dashboard)
- Click "Add New" → "Project"
- Import your forked repository
4. **Configure environment variables**
Add the following environment variables in the Vercel project settings:
- `DATABASE_URL`: Your Neon PostgreSQL connection string (from step 2)
- `JWT_SECRET`: A secure random string for JWT token signing (generate with `openssl rand -hex 32`)
5. **Deploy**
Click "Deploy" and wait for the build to complete.
6. **Set up the database schema**
After deployment, go to your Vercel project dashboard:
- Navigate to "Settings" → "Environment Variables"
- Verify that your `DATABASE_URL` is correctly set
- Go back to "Deployments" and trigger a new deployment to ensure the database schema is applied
## 💻 Local Development
### Prerequisites
- Node.js 18+ installed
- npm or yarn package manager
- Git installed
- PostgreSQL database (local or Neon)
### Setup Instructions
1. **Clone the repository**
```bash
git clone
cd chatbot-builder
```
2. **Install dependencies**
```bash
npm install
# or
yarn install
```
3. **Set up environment variables**
```bash
# Copy the example environment file
cp .env.example .env
```
Update the `.env` file with your values:
- `DATABASE_URL`: Your PostgreSQL connection string
- `JWT_SECRET`: A secure random string for JWT token signing
4. **Initialize the database**
```bash
# Run Prisma migrations
npx prisma migrate deploy
```
5. **Create a test user** (optional)
```bash
# This will create a user with email: test@test.com and password: test
npm run create-test-user
```
6. **Start the development server**
```bash
npm run dev
```
7. **Access the application**
- Open your browser and navigate to `http://localhost:3000`
- Log in with your credentials (or use test@test.com if you created the test user)
- Go to the Settings page to add your OpenAI API key
## 🔑 API Key Management
This application uses user-specific OpenAI API keys:
- Each user must provide their own OpenAI API key in the settings page
- API keys are securely stored in the database
- No global API key is required for deployment
- Users can update or change their API keys at any time
## 📦 Project Structure
```
chatbot-builder/
├── app/ # Next.js app directory
│ ├── api/ # API routes
│ ├── bots/ # Bot management pages
│ ├── files/ # File management pages
│ └── settings/ # User settings page
├── components/ # React components
├── lib/ # Utility functions
├── prisma/ # Database schema and migrations
└── public/ # Static assets
```
## 🤝 Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📄 License
This project is licensed under the MIT License - see the LICENSE file for details.