Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vi-ssh-al/study-aura
StudyAura is an ed-tech platform built with the MERN stack (MongoDB, Express.js, React.js, Node.js) to provide a dynamic learning experience for students and a robust course management system for instructors. The platform features a ReactJS-
https://github.com/vi-ssh-al/study-aura
cloudinary expressjs html-css javascript mongodb-atlas nodejs react redux tailwindcss
Last synced: 10 days ago
JSON representation
StudyAura is an ed-tech platform built with the MERN stack (MongoDB, Express.js, React.js, Node.js) to provide a dynamic learning experience for students and a robust course management system for instructors. The platform features a ReactJS-
- Host: GitHub
- URL: https://github.com/vi-ssh-al/study-aura
- Owner: vi-SSH-al
- License: mit
- Created: 2024-07-12T18:47:13.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-18T18:29:27.000Z (5 months ago)
- Last Synced: 2024-11-15T05:46:10.200Z (2 months ago)
- Topics: cloudinary, expressjs, html-css, javascript, mongodb-atlas, nodejs, react, redux, tailwindcss
- Language: JavaScript
- Homepage: https://study-aura.vercel.app
- Size: 28 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StudyAura
## Live
https://study-aura-frontend-wheat.vercel.app/ \
otp mail will be in your spam section
## Installation
1. Clone the repository:
2. Navigate to the project directory: `cd `
3. Install dependencies: `npm install`
## Configuration
1. For only frontend replace the example.env file in root with .env and
```sh
npm run start
```
2. Replace an `example.env` files with your enviroment virables
3. Start the development server.
```sh
npm run dev
```
## Contributing
Contributions are welcome! If you have any suggestions or find any issues, please feel free to open an issue or a pull request.
## System Architecture
The Study Aura EdTech 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 allows for the creation of dynamic and responsive user interfaces, crucial for providing an engaging learning experience to students. The front-end communicates with the back-end using RESTful API calls.
#### Front End Pages
For Students:
- **Homepage:** A brief introduction to the platform with links to the course list and user details.
- **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.
#### Front-end Tools and Libraries
To build the front-end, we use frameworks and libraries such as ReactJS, CSS, and Tailwind for styling, and Redux for state management.
### 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:** StudyAura 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.
#### Back-end Frameworks, Libraries, and Tools
The back-end of StudyAura uses various frameworks, libraries, and tools to ensure its functionality and performance, including:
- **Node.js:** Used as the primary framework for the back-end.
- **Express.js:** Used as a web application framework, providing a range of features and tools for building web applications.
- **MongoDB:** Used as the primary database, providing a flexible and scalable data storage solution.
- **JWT (JSON Web Tokens):** Used for authentication and authorization, providing a secure and reliable way to manage user credentials.
- **Bcrypt:** Used for password hashing, adding an extra layer of security to user data.
- **Mongoose:** Used as an Object Data Modeling (ODM) library, providing a way to interact with MongoDB using JavaScript.
#### Data Models and Database Schema
The back-end of StudyAura 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.
### Architecture Diagram
Below is a high-level diagram that illustrates the architecture of the StudyAura EdTech platform:
