ChatBot Project
Welcome to the ChatBot project! This is a conversational AI chat bot built using modern web technologies including Next.js, TypeScript, Tailwind CSS for the frontend, and Convex and Clerk for backend services. The chat bot can answer questions and have a normal conversation with users.
Features
- Answer user questions with AI-driven responses.
- Engage in natural conversations.
- Modern, responsive UI built with Tailwind CSS.
- Secure user authentication and session management using Clerk.
- Scalable backend hosted on Convex.
Getting Started
Prerequisites
Before you begin, ensure you have met the following requirements:
- Node.js and npm installed.
- A Convex account and project setup.
- A Clerk account for authentication.
Installation
- Clone the repository:
- git clone https://github.com/yourusername/chatbot-project.git
- cd chatbot-project
-
Install dependencies:
-
Set up environment variables:
Create a .env.local file in the root directory and add your Convex and Clerk API keys:
- NEXT_PUBLIC_CONVEX_URL=your_convex_url
- NEXT_PUBLIC_CLERK_FRONTEND_API=your_clerk_frontend_api
- CLERK_API_KEY=your_clerk_api_key
- Running the Project
To run the development server:
- npm run dev
- Open http://localhost:3000 with your browser to see the result.
Technologies Used:
Contributing
Contributions are welcome! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch: git checkout -b feature/your-feature-name.
- Make your changes and commit them: git commit -m 'Add some feature'.
- Push to the branch: git push origin feature/your-feature-name.
- Submit a pull request.