hookshoot / gatere-bot

An AI-powered chatbot project inspired by ChatGPT, and leveraging OpenAI API for real-time language processing. Built with NextJS, Tailwind CSS, MongoDB, Mongoose, React Markdown, Vercel AI SDK, and Next Auth.

!GitHub deployments](https://img.shields.io/github/deployments/hookshoot/gatere-bot/production?style=flat&logo=vercel&logoColor=white&label=vercel)\n# GatereBot\nGatereBot is a ChatGPT-inspired project that leverages the OpenAI API for real-time natural language processing. It is built using NextJS, Tailwind CSS, OpenAI API, MongoDB and Mongoose for chat storage, React Markdown, Vercel AI SDK, and Next Auth for authentication.\n

\n\n\n!GatereBotAuth](https://firebasestorage.googleapis.com/v0/b/hookshoot.appspot.com/o/gaterebot1.png?alt=media&token=9900d90c-15a6-4c02-bad1-a5a3db557f73)\n\n/a>\n</div>\n---\n

\n\n\n!GatereBot](https://firebasestorage.googleapis.com/v0/b/hookshoot.appspot.com/o/gaterebot3.png?alt=media&token=0f51faf8-f61b-4a51-9320-14e13f3e0e10)\n\n/a>\n</div>\n## Table of Contents\n\n- Features\n- Technologies Used\n- Installation\n- Deployment\n- Contributing\n## Features\n- Utilizes NextJS and Tailwind CSS for a responsive and modern UI\n- Real-time natural language processing using OpenAI API\n- Chat storage in MongoDB with Mongoose\n- User authentication with Next Auth\n- Integration with Vercel AI SDK for enhanced functionality\n- Supports rendering of React Markdown for rich content\n## Technologies\n- NextJS: React framework for server-side rendering and optimal performance.\n- Tailwind CSS: A utility-first CSS framework for rapidly designing responsive web pages.\n- OpenAI API: Enables real-time natural language processing for user interactions.\n- MongoDB: NoSQL database for flexible data storage.\n- Mongoose: ODM for flexible data modeling in MongoDB.\n- React Markdown: Library for rendering Markdown content as React components.\n- Vercel AI SDK: Integrates AI capabilities into applications deployed on Vercel.\n- Next Auth: Authentication solution for secure access with social logins.\n## Installation\n1. Clone the repository:\n\nbash\ngit clone https:\/\/github.com\/hookshoot\/gatere-bot.git\n\n2. Install dependencies:\n\nbash\ncd gatere-bot\npnpm install\n\n3. Create a .env file in the root directory and define the environment variables stated below:\n\nbash\nNEXTAUTH_SECRET=replace_me\nGITHUB_ID=replace_me\nGITHUB_SECRET=replace_me\nGOOGLE_CLIENT_ID=replace_me\nGOOGLE_CLIENT_SECRET=replace_me\nOPENAI_API_KEY=replace_me\nMONGODB_URI=replace_me\n\n4. Run the development server:\n\nbash\npnpm run dev\n\n5. Visit the local server at http://localhost:3000.\n## Deployment\nGatereBot is deployed on Vercel. Pushes to main branch trigger automatic deployments. Visit the live version at https://gaterebot.vercel.app/\n## Contributing\nContributions are welcome. Follow these steps to contribute:\n1. Fork the repository.\n2. Create a new branch for your feature:\n\nbash\ngit checkout -b feature-name\n\n3. Commit your changes:\n\nbash\ngit commit -m "Your commit message here."\n\n4. Push your branch to your fork:\n\nbash\ngit push origin feature-name\n\n5. Open a pull request to the original repository's main branch.