StudyPal: Your AI-Powered Personalized Learning Companion

StudyPal is an advanced web application that harnesses the power of artificial intelligence to deliver personalized and adaptive learning experiences. By integrating CopilotKit, a robust tool for incorporating large language models (LLMs) into web applications, StudyPal empowers students to embark on customized learning journeys that cater to their unique needs and preferences.

Dev.to article

Link to article: https://dev.to/rajesh-adk-137/studypal-your-ai-powered-personalized-learning-companion-59d

Features

• Subject Selection and Personalization: Choose from a curated list of subjects and provide details about your educational background to tailor learning materials and exercises.
• Intelligent Study Material Generation: AI-powered generation of concise and comprehensive study materials, distilling the essence of selected subject matter into key points.
• MCQ Practice with AI-Powered Assistance: Engage in interactive multiple-choice question (MCQ) practice sessions with an integrated AI copilot providing context-specific hints and guidance without revealing complete answers.
• Rationale Insights: Query the AI copilot for detailed explanations and rationales behind each answer choice, promoting critical thinking and a deeper understanding of the subject matter.
• Progress Tracking and Scoreboard: Track progress and measure performance during MCQ practice sessions with a comprehensive scoreboard feature, fostering continuous learning and improvement.

Demo

InShot_20240507_123800395.mp4

Dependencies

• React
• Node
• Express
• Tailwind
• CopilotKit
• Typescript

Getting Started

Installation

Clone the repository:

git clone https://github.com/rajesh-adk-137/StudyPal.git

Go to repository:

cd StudyPal

Install dependencies:

Navigate to the frontend directory

npm install

Navigate to backend directory

npm install

Set up environment variables:

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

OPENAI_API_KEY=YOUR_OPENAI_API_KEY

**Here we have used gpt-3.5-turbo as our OpenAI model. If you want to use different OpenAI model change model

    const adapterOptions = {
      model: "gpt-3.5-turbo"
    };

in backend\server.js.

Start the development server:

For the frontend (currently inside StudyPal directory):

cd frontend
npm run dev

For the backend (currently inside StudyPal directory):

cd backend
npm start

Visit the Page

Open your browser and navigate to http://localhost:5173.

If your frontend is not running on http://localhost:5173 but some other url then you have to change cors address from backend\server.js. Inside HEADERS you have to change

  "Access-Control-Allow-Origin": "http://localhost:5173",

to

  "Access-Control-Allow-Origin": "YOUR_FRONTEND_BASE_URL",

Screenshots

Contributing

We welcome contributions from the community! If you'd like to contribute to StudyPal, please follow these steps:

1. Fork the Repository: Click the "Fork" button on GitHub to create your copy.

2. Clone Your Fork:

  git clone https://github.com/yourusername/StudyPal.git

3. Create a Branch:

  git checkout -b your-branch-name

4. Make Changes: Implement your changes.

5. Commit Your Changes:

  git commit -m "Description of your changes"

6. Push Your Changes:

  git push -u origin your-branch-name

7. Create a Pull Request: Submit your changes for review.

License

This project is licensed under the MIT License.

Acknowledgments

• CopilotKit for their powerful AI integration toolkit
• React for the amazing JavaScript library
• Node.js for the robust JavaScript runtime
• Express.js for the minimalist web application framework
• OpenAI for their cutting-edge language models