Skip to content

README.md

Latest commit

 

History

History
162 lines (117 loc) · 2.54 KB

README.md

File metadata and controls

162 lines (117 loc) · 2.54 KB
Raw

🤖 United GPT

Sigma GPT is a full-stack AI chatbot built using the MERN Stack and the Groq API. It delivers a fast, interactive, and responsive AI chat experience through a clean and modern user interface.

This project demonstrates full-stack web development, REST API integration, and AI-powered conversations.

✨ Features

  • 🤖 AI-powered chatbot
  • ⚡ Fast responses using the Groq API
  • 💬 Real-time conversation experience
  • 🎨 Clean and responsive user interface
  • 🔗 REST API integration
  • 👨‍💻 Simple and easy-to-use chat interface

🛠️ Tech Stack

Frontend

  • React.js (Vite)
  • CSS

Backend

  • Node.js
  • Express.js

Database

  • MongoDB
  • Mongoose

AI Integration

  • Groq API

Deployment

  • Frontend: Vercel
  • Backend: Render

📂 Project Structure

SigmaGPT/
│
├── Backend/
│   ├── models/
│   ├── routes/
│   ├── utils/
│   ├── .env
│   ├── package.json
│   ├── package-lock.json
│   └── server.js
│
├── Frontend/
│   ├── public/
│   ├── src/
│   │   ├── assets/
│   │   ├── App.jsx
│   │   ├── App.css
│   │   ├── Chat.jsx
│   │   ├── Chat.css
│   │   ├── ChatWindow.jsx
│   │   ├── ChatWindow.css
│   │   ├── Sidebar.jsx
│   │   ├── Sidebar.css
│   │   ├── MyContext.jsx
│   │   ├── main.jsx
│   │   └── index.css
│   ├── .env
│   ├── index.html
│   ├── package.json
│   ├── package-lock.json
│   └── eslint.config.js
│
├── .gitignore
├── LICENSE
└── README.md

⚙️ Installation & Setup

1️⃣ Clone the Repository

git clone https://github.com/anchallll02/SigmaGPT.git

2️⃣ Navigate to the Project Directory

cd SigmaGPT

3️⃣ Install Dependencies

Backend

cd Backend
npm install

Frontend

cd ../Frontend
npm install

▶️ Run the Project

Start the Backend

cd Backend
npm start

Start the Frontend

cd Frontend
npm run dev

Open your browser and visit:

http://localhost:5173

🔑 Environment Variables

Create a .env file inside the Backend directory and add:

MONGO_URI=your_mongodb_connection_string
GROQ_API_KEY=your_groq_api_key
PORT=5000

📄 License

This project is licensed under the MIT License.

👩‍💻 Author

Anchallll02