Edvora — EdTech Platform

🚀 Live site: https://edvora-beryl.vercel.app

A full-stack EdTech platform for creating, consuming, and rating educational content. StudyNotion (Edvora) combines a React front-end, Node/Express back-end, and MongoDB to deliver a fast, responsive learning experience — including an AI-powered virtual teacher.

---

Demo accounts (for testing)

Use these accounts on the live demo or in a local environment seeded with demo data.

• Instructor
  • Email: aryan.singh766768@gmail.com
  • Password: 123456
• Student
  • Email: shambhudhanpal@gmail.com
  • Password: 123456

---

Quick demo screenshots

---

Table of Contents

• About
• Key Features
• Tech Stack
• Architecture & Data Models
• API Endpoints (Overview)
• Installation & Local Development
• Configuration (.env)
• Usage
• Contributing
• Future Enhancements
• Contact

---

About

Edvora aims to simplify digital learning with:

• High-quality courses (video + docs + markdown content)
• Instructor tools to create/manage/sell courses
• Student-facing features: wishlist, cart, course progress, ratings
• AI Virtual Teacher that generates teaching videos and transcripts on a topic

---

Key Features

• User authentication and roles (Student / Instructor)
• Course creation, editing, and media management
• Course listing, ratings, wishlist, and checkout flow
• Razorpay payment integration
• Cloudinary for media storage
• AI Virtual Teacher: topic → teaching video + transcript/explanation
• Markdown content support for lessons/documents
• Instructor analytics (views, clicks, ratings)

---

Tech Stack

• Front-end: React, Tailwind CSS, Redux (state management)
• Back-end: Node.js, Express
• Database: MongoDB (Mongoose ODM)
• Auth: JWT, bcrypt
• Media: Cloudinary
• Payments: Razorpay
• Misc: Nodemailer (mail), any AI / DID services for virtual teacher

---

Architecture & Data Models

The platform follows a client-server architecture:

• Client (React): UI, routing, authentication flows, course consumption
• Server (Express): REST API, authentication, business logic
• Database (MongoDB): users (students/instructors), courses, orders, ratings

Representative Schemas:

• User (student/instructor): name, email, passwordHash, role, profile
• Course: title, description, instructorId, media (Cloudinary), price, ratings, lessons (markdown)
• Order / Checkout: studentId, courseId(s), paymentStatus, razorpay meta

See images/schema.png for the visual database schema and images/architecture.png for the system diagram.

---

API Endpoints — Overview

The API follows REST conventions. For full API docs, see the API documentation in the repo or /api-docs.

Common endpoints:

• POST /auth/register — register a user
• POST /auth/login — login and receive JWT
• GET /courses — list all courses
• GET /courses/:id — get a single course
• POST /courses/create — create a course (instructor)
• PATCH /courses/:id — update a course
• DELETE /courses/:id — delete a course
• POST /ai/teacher — generate AI teaching output (video + transcript)
• POST /payment/checkout — start checkout / create order (Razorpay)

---

Installation & Local Development

1. Clone the repository:

   git clone https://github.com/AryanCodeWizard/Edvora.git
   cd Edvora

2. Install root and client dependencies:

   • If there's a single package.json (monorepo), run:

     npm install

   • If server and client are separate:

     # server
     npm install
     # clientcd client
     npm install

3. Start development:

   • If scripts are available in root:

     npm run dev

   • Or start server and client separately:

     # in repo root (server)
     npm run dev
     # in client
     npm start

4. Open the app:

   • Default client: http://localhost:3000
   • API: http://localhost:5000 (or configured port)

Notes:

• If using concurrently or a single dev script, check package.json for exact commands (e.g., dev, start).

---

Configuration (.env)

Create a .env file in the project root with the following variables (example values shown):

MONGODB_URI=your-mongodb-connection-string
JWT_SECRET=your-jwt-secret
CLOUD_NAME=your-cloudinary-cloud-name
CLOUD_API_KEY=your-cloudinary-api-key
CLOUD_API_SECRET=your-cloudinary-api-secret
RAZORPAY_KEY_ID=your-razorpay-key-id
RAZORPAY_SECRET=your-razorpay-secret
MAIL_USER=your-email@example.com
MAIL_PASS=your-email-app-password
GROQ_API_KEY=your-groq-key
DID_API_KEY=your-did-key
DID_AVATAR_URL=https://example.com/avatar.png
PORT=5000

Tips:

• Keep .env out of version control.
• Use a separate .env for development and production.

---

Usage

• Register as an Instructor or Student.
• Instructors: create courses, upload media via Cloudinary, set prices.
• Students: browse courses, add to wishlist/cart, checkout via Razorpay, access course content.
• AI Teacher: submit a topic to /ai/teacher to generate teaching media and transcript.

---

Contributing

Contributions are welcome! Suggested workflow:

1. Fork the repo
2. Create a feature branch: git checkout -b feat/your-feature
3. Commit your changes: git commit -m "Add feature"
4. Push: git push origin feat/your-feature
5. Open a pull request describing your changes

Please include tests or manual testing steps for non-trivial changes.

---

Future Enhancements

• Better AI teacher UX (custom voices, adjustable lesson length)
• Course previews and free trial lessons
• Subscriptions and coupon support
• Internationalization (i18n)
• Improved analytics dashboard
• Unit & integration tests across the stack

---

License

Add a LICENSE file to clarify project licensing. If you want, use MIT or another permissive license.

---

Contact

Maintainer: AryanCodeWizard (https://github.com/AryanCodeWizard)
For questions about the project or to request access to demo data, open an issue in the repository.

---

Thank you for using Edvora — happy building and learning!