metaloozee / learnify

Engage in personalized learning that adapts to your pace and preferences.

Learnify

Introduction · Tech Stack · Features · Getting Started · Contributing · License

Introduction

This is a Personalized Learning Platform designed to enhance the learning experience for both teachers and students. The platform utilizes cutting-edge technologies to deliver tailored educational content based on teacher-provided notes. Teachers can manage subjects and notes, while students gain access to personalized learning materials including notes, flashcards, and quizzes. Additionally, an AI tutor in the form of a RAG-based chatbot assists students in their learning journey. The platform's dashboard draws inspiration from Google Classroom to provide an intuitive user experience.

Tech Stack

• Next.js
• Supabase (Authentication & Database)
• Pinecone (Vector Database)
• LangChain
• ui/shadcn (User Interface)

Features

• Two user views: Teacher and Student
• Teacher can manage subjects and notes
• Student access to personalized content generated by AI
• Personalized content includes notes, flashcards, and mini quizzes
• RAG-based chatbot serves as an AI tutor for students

Getting Started

Prerequisites

• Node.js
• npm

Installation

1. Clone the repository:

   git clone https://github.com/metaloozee/learnify.git

2. Install the dependencies:

   cd yourproject
   pnpm install

3. Configure the Environment Variables

   NEXT_PUBLIC_SUPABASE_URL=
   NEXT_PUBLIC_SUPABASE_ANON_KEY=
   OPENAI_API_KEY=
   UPSTASH_REDIS_REST_URL=
   UPSTASH_REDIS_REST_TOKEN=
   RESEND_API_KEY=
   

4. Start the application:

   pnpm run dev

5. Open your browser and visit http://localhost:3000 to view the application.

Contributing

We welcome contributions from the community. Before you start contributing, please make sure to read and follow our Contributing Guidelines. This will provide you with information on the development process, coding style, testing procedures, and other important aspects of contributing to the Personalized Learning Platform.

License

This project is licensed under GNU GENERAL PUBLIC LICENSE

Repo Activity