SocrAI - Your AI Coding Mentor

🧠 Think Before You Copy

SocrAI helps you solve your coding problems by guiding your thinking process, not by giving away solutions. Choose your guidance style with our unique pill modes.

🚀 Overview

SocrAI is an innovative AI coding mentor that adapts to your skill level. Whether you're a beginner, intermediate, or advanced programmer, SocrAI provides tailored guidance to help you become a better developer through active learning rather than passive copying.

✨ Features

• Personalized Learning Experience: Choose from three different guidance levels (Green, Blue, Red pills)
• Interactive Problem Solving: Submit coding problems or questions and receive customized help
• Socratic Teaching Method: Learn through guided questioning rather than direct solutions
• Code Analysis: Get real-time feedback on your code with best practice suggestions
• Multi-language Support: Works with all major programming languages
• Debugging Assistance: Helps you identify and fix errors in your code

🟢🔵🔴 Pill Modes

Green Pill (Beginner)

• Step-by-step structured explanations
• "Let's solve this together" approach
• Full thought process guidance
• Focuses on learning fundamentals

Blue Pill (Intermediate)

• Fewer direct hints
• Guiding questions that nudge you forward
• Trains critical thinking skills
• Encourages independent problem-solving

Red Pill (Advanced)

• Minimal help and guidance
• Topic classification only
• Encourages full independent problem-solving
• For those who want to truly master coding

🛠️ Technology Stack

• Frontend:

  • React with TypeScript
  • Tailwind CSS for styling
  • Framer Motion for animations
  • Accertinity UI for amazing components

• Backend:

  • Django REST Framework
  • PostgreSQL database

• AI Integration:

  • OpenAI API for AI-powered responses
  • Custom prompting system for different pill modes

🚀 Getting Started

Prerequisites

• Node.js (v14.0.0 or higher)
• npm or yarn
• Python 3.8+
• pip

Installation

Frontend

1. Clone the repository:

   git clone https://github.com/yourusername/Hackstreet-Boys_AMUHACKS-4.0
   cd Hackstreet-Boys_AMUHACKS-4.0/frontend

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

Backend

1. Navigate to the backend directory:

   cd ../server

2. Create and activate a virtual environment:

   python -m venv myenv
   source venv/bin/activate  # On Windows, use: venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Set up environment variables:

   cp .env.example .env

   Edit the .env file to add your OpenAI API key and database credentials.

5. Run migrations:

   python manage.py migrate

6. Start the Django server:

   python manage.py runserver

7. Open your browser and navigate to http://localhost:8080

📝 How It Works

1. Submit Your Problem: Paste your coding problem or doubt into SocrAI. Whether it's a LeetCode challenge, a bug in your code, or a conceptual question.

2. Choose Your Pill Mode: Select the level of guidance you want: Green (beginner), Blue (intermediate), or Red (advanced) to customize your learning experience.

3. Receive Tailored Guidance: Our AI mentor provides guidance based on your chosen pill mode, helping you think through the problem without spoon-feeding solutions. OpenAI powers the responses, but our custom prompt engineering ensures the AI maintains the appropriate teaching style for each pill mode.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the project
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

🙏 Acknowledgements

• Inspired by Socratic teaching methods
• Built with React, TypeScript, and Django
• AI responses powered by OpenAI
• Animations powered by Framer Motion and Accertinity UI

Collaborators

• Inshamul haque
• Murtza Ali