Skip to content

The-Learning-Algorithm/ai-nda-chatbot

Repository files navigation

NDA Chatbot

A Next.js application that provides an interactive chatbot interface for handling NDA (Non-Disclosure Agreement) related queries and conversations.

Features

  • Interactive chatbot interface
  • OpenAI-powered responses
  • Modern React components with Tailwind CSS
  • TypeScript support
  • Responsive design

Prerequisites

  • Node.js 18+
  • npm, yarn, pnpm, or bun
  • OpenAI API key

Getting Started

1. Clone the repository

git clone https://github.com/The-Learning-Algorithm/ai-nda-chatbot
cd ai-nda-chatbot

2. Install dependencies

npm install
# or
yarn install
# or
pnpm install
# or
bun install

3. Environment Setup

Create a .env file in the root directory and add your OpenAI API key:

OPENAI_API_KEY=your_openai_api_key_here

Important: Replace your_openai_api_key_here with your actual OpenAI API key. You can get one by signing up at OpenAI's platform.

4. Run the development server

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the application.

Tech Stack

  • Framework: Next.js 15.3.3
  • Language: TypeScript
  • Styling: Tailwind CSS
  • Icons: Heroicons
  • AI: OpenAI API

Project Structure

ai-nda-chatbot/
├── app/                 # Next.js app directory
├── lib/                 # Utility functions and configurations
├── public/              # Static assets
├── .env                 # Environment variables (create this)
├── package.json         # Dependencies and scripts
└── README.md            # This file

Environment Variables

Variable Description Required
OPENAI_API_KEY Your OpenAI API key for chatbot functionality Yes

Deployment

Vercel (Recommended)

The easiest way to deploy your Next.js app is to use the Vercel Platform.

  1. Push your code to GitHub
  2. Import your project to Vercel
  3. Add your OPENAI_API_KEY environment variable in Vercel's dashboard
  4. Deploy!

Other Platforms

For other deployment platforms, make sure to:

  1. Set the OPENAI_API_KEY environment variable
  2. Run npm run build to build the application
  3. Start the server with npm run start

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.

Support

If you encounter any issues or have questions, please open an issue on the repository.

About

AI Chatbot to Q&A Legal Documents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published