Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/boddepallyvenkatesh06/study-notion-lms

StudyNotion is a fully functional ed-tech platform that enables users to create, consume, and rate educational content. The platform is built using the MERN stack, which includes ReactJS, NodeJS, MongoDB, and ExpressJS.
https://github.com/boddepallyvenkatesh06/study-notion-lms

edtech-software javascript lms mern-stack-development mern-stack-project reactjs

Last synced: 17 days ago
JSON representation

Host: GitHub
URL: https://github.com/boddepallyvenkatesh06/study-notion-lms
Owner: BoddepallyVenkatesh06
License: mit
Created: 2024-02-26T14:26:39.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-02-26T15:18:07.000Z (10 months ago)
Last Synced: 2024-02-26T16:36:42.509Z (10 months ago)
Topics: edtech-software, javascript, lms, mern-stack-development, mern-stack-project, reactjs
Language: JavaScript
Homepage: https://study-notion-mern-stack.netlify.app/
Size: 25.5 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Project Description 📝
StudyNotion is a fully functional ed-tech platform that enables users to create, consume, and rate educational content.

The platform is built using the **MERN stack**, which includes ReactJS, NodeJS, MongoDB, and ExpressJS.

Live link 🌍📡 - [ https://study-notion-mern-stack.netlify.app/ ]

## Table of Contents

| Section | Description |
|-------------------------|----------------------------------------------|
| [StudyNotion Aim](#studynotion-aim-) | 📚 Overview of StudyNotion's goals |
| [Tech Stack](#tech-stack-) | 💻🔧 Technologies used in the project |
| [System Architecture](#system-architecture-) | 🏰 Overview of the system architecture |
| [Architecture Diagram](#architecture-diagram-) | 🏗️ Diagram illustrating the architecture |
| [Schema](#schema-) | 🗂 Explanation of data schemas used |
| [React Hooks](#react-hooks-) | 🎣 Overview of React Hooks utilized |
| [React Library](#react-library-) | ⚛️📚 Overview of React Libraries used |
| [Screen Preview](#screen-preview-) | 🖥️ Screen Preview |

## StudyNotion Aim 📚

1️⃣ A seamless and interactive learning experience for students, making education more accessible and engaging.

2️⃣ A platform for instructors to showcase their expertise and connect with learners across the globe.

## Tech Stack 💻🔧

## Frontend 🎨 :

## Backend ⚙️ :

## Database 🛢️ :

## Cloudinary Integration ☁️

## System Architecture 🏰

☝ The StudyNotion ed-tech platform consists of three main components:

The front end, the back end, and the database. The platform follows a client-server architecture, with the front end serving as the client and the back end and database serving as the server.

🎨 Front-end

The front end of the platform is built using ReactJS, which is a popular JavaScript library for building user interfaces. ReactJS allows for the creation of dynamic and responsive user interfaces also **Loading Skeleton**, which are critical for providing an engaging learning experience to the students. The front end communicates with the back end using RESTful API calls.

⚙️ Back-end

The back end of the platform is built using NodeJS and ExpressJS, which are popular frameworks for building scalable and robust server-side applications. The back end provides APIs for the front end to consume, which include functionalities such as user authentication, course creation, and course consumption. The back end also handles the logic for processing and storing the course content and user data.

🛢️ Database

The database for the platform is built using MongoDB, which is a NoSQL database that provides a flexible and scalable data storage solution. MongoDB allows for the storage of unstructured and semi-structured data, which is useful for storing course content such as videos, images, and PDFs. The database stores the course content, user data, and other relevant information related to the platform.

## Architecture Diagram 🏗️

Here is a high-level diagram that illustrates the architecture of the StudyNotion ed-tech platform:

#### The front end of StudyNotion has all the necessary pages that an ed-tech platform should have. Some of these pages are:

For Students:
- **Homepage 🏠:** A brief introduction to the platform with links to the course list and user details and random background.
- **Course List 📚:** A list of all the courses available on the platform, along with their descriptions and ratings.
- **Wishlist 💡:** Displays all the courses that a student has added to their wishlist.
- **Cart Checkout 🛒 :** Allows the user to complete course purchases.
- **Course Content 🎓:** Presents the course content for a particular course, including videos and related material.
- **User Details 👤:** Provides details about the student's account, including their name, email, and other relevant information.
- **User Edit Details ✏️:** Allows students to edit their account details.

For Instructors:
- **Dashboard 📊:** Offers an overview of the instructor's courses, along with ratings and feedback for each course.
- **Insights 📈:** Provides detailed insights into the instructor's courses, including the number of views, clicks, and other relevant metrics.
- **Course Management Pages 🛠️:** Enables instructors to create, update, and delete courses, as well as manage course content and pricing.
- **View and Edit Profile Details 👀:** Allows instructors to view and edit their account details.

### Back-end ⚙️

The back-end of the platform is built using NodeJS and ExpressJS, providing APIs for the front-end to consume. These APIs include functionalities such as user authentication, course creation, and course consumption. The back-end also handles the logic for processing and storing the course content and user data.

#### Back-end Features

- **User Authentication and Authorization 🔐:** Students and instructors can sign up and log in to the platform using their email addresses and passwords. The platform also supports OTP (One-Time Password) verification and forgot password functionality for added security.
- **Course Management 🛠️:** Instructors can create, read, update, and delete courses, as well as manage course content and media. Students can view and rate courses.
- **Payment Integration 💳:** Students will purchase and enroll in courses by completing the checkout flow, followed by Razorpay integration for payment handling.
- **Cloud-based Media Management ☁️ :** StudyNotion uses Cloudinary, a cloud-based media management service, to store and manage all media content, including images, videos, and documents.
- **Markdown Formatting ✍️:** Course content in document format is stored in Markdown format, allowing for easier display and rendering on the front-end.

#### Data Models and Database Schema

The back-end of StudyNotion uses several data models and database schemas to manage data, including:

- **Student Schema 🧑‍🎓:** Includes fields such as name, email, password, and course details for each student.
- **Instructor Schema 👩‍🏫:** Includes fields such as name, email, password, and course details for each instructor.
- **Course Schema 📚:** Includes fields such as course name, description, instructor details, and media content.

### Database 🛢️
The database for the platform is built using MongoDB, a NoSQL database that provides a flexible and scalable data storage solution. MongoDB allows for the storage of unstructured and semi-structured data. The database stores the course content, user data, and other relevant information related to the platform.

## Schema 📋

## React Hooks 🎣

Utilized several React hooks for efficient state management and dynamic behavior:

- `useState`
- `useEffect`
- `useDispatch`
- `useParams`
- `useSelector`
- `useLocation`
- `useNavigate`
- `useRef`
- `useForm`
- `useDropzone`
- `Custom-Hook`

## 📚 **React Library**:

- 🚀 **Lazy Loading**: Enhance performance by lazily loading images using the react-lazy-load-image library.
- 📊 **Chart.js:** Versatile charting library for creating interactive and visually appealing charts.
- 🎭**Framer Motion:** Animation library for React, providing smooth and expressive motion.
- 📁 **React Dropzone:** Drag-and-drop file uploader for React applications.
- 🍞 **React Hot Toast:** Elegant and customizable toast notifications for React applications.
- 🔢 **React OTP Input:** Input component for one-time password entry in React forms.
- 📊 **React Super Responsive Table:** Highly responsive and feature-rich table component for React.
- 🔄 **Swiper:** Modern touch slider for mobile and desktop browsers.
- 🖋️ **React Type Animation:** Simple and configurable typing animation component for React.
- 🎥 **Video React:** React-based video player for building rich multimedia experiences in web applications.

## 🖥️ Screen Preview :

# Random Home Page Background 🏠