Skip to content

parikshit-sood/roast-bot

Repository files navigation

Roast Bot 🤖🔥

Roast Bot is a fun and engaging chatbot that generates humorous, witty, and lighthearted "roasts" based on user prompts. Built with a modern tech stack, Roast Bot combines interactive front-end components with a robust backend API to deliver a unique conversational experience.


Features

  • 💬 Interactive Chat Interface: Engage in real-time chats with Roast Bot.
  • 🧠 Dynamic Responses: AI-powered roasts tailored to user inputs.
  • Seamless UX: A responsive design for smooth interaction across devices.
  • 🛠 Customizable API: Easily extend or modify the bot’s behavior.

Tech Stack

Frontend

  • NextJS and React: Leveraging hooks for state management and rendering.
  • Tailwind CSS: For sleek, modern, and responsive UI styling.

Backend

  • Next.js API Routes: Simplifies server-side logic.
  • Node.js: For efficient and scalable API operations.

AI & NLP

  • Integration with Cerebras: Provides context-aware and humorous responses (e.g., OpenAI GPT or custom NLP model).

Deployment

  • Vercel: For fast and reliable hosting.

Installation & Setup

Follow these steps to get Roast Bot running locally:

Prerequisites

  • Node.js (v14 or higher)
  • NPM or Yarn
  • Git

Steps

  1. Clone the Repository:
    git clone https://github.com/parky-sood/roast-bot.git
    cd roast-bot
  2. Install Dependencies:
    npm install
    Or, if you're using Yarn:
    yarn install
  3. Set Up Environment Variables: Create a .env.local file in the project root and include the following credentials:
     NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
     NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-auth-domain
     NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
     NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your-bucket
     NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your-sender-id
     NEXT_PUBLIC_FIREBASE_APP_ID=your-app-id
     NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your-measurement-id
     NEXT_PUBLIC_CEREBRAS_API_KEY=your-api-key
  4. Run the Development Server:
    npm run dev

Usage

  1. Launch the application and interact with Roast Bot via the intuitive chat interface.
  2. Type a prompt to receive a witty response.
  3. Customize the bot's personality by modifying the backend roast generation logic.

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository:
git fork https://github.com/parky-sood/roast-bot.git
  1. Clone your forked repository
git clone https://github.com/your-username/roast-bot.git
cd roast-bot
  1. Create a new branch for your feature or fix:
git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git commit -m "Add your feature or fix description"
  1. Push to your branch:
git push origin feature/your-feature-name
  1. Open a pull reqeuest from your branch to the main reposity.

Future Enhancements

  • Add support for multiple languages
  • Include a roast intensity slider for customizable humor levels
  • Support image inputs from users, so images can also be roasted

Acknowledgements

  • Inspired by the humor and creativity of online communities like Reddit
  • Built with 💻, ☕, and a touch of mischief.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors