| 🌟 Stars | 🍴 Forks | 🐛 Issues | 🔔 Open PRs | 🔕 Close PRs |
 |
 |
 |
 |
 |
| Event Logo | Event Name | Event Description |
|---|---|---|
 |
GirlScript Summer of Code 2024 | GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development. |
- Project Description
- Technology Used
- System Architecture
- Front End Technology
- Back End Technology
- API Design
- How to Contribute
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. StudyNotion aims to provide:
- A seamless and interactive learning experience for students, making education more accessible and engaging.
- A platform for instructors to showcase their expertise and connect with learners across the globe. In the following sections, we will cover the technical details of the platform, including:
- System architecture: The high-level overview of the platform's components and diagrams of the architecture.
- Front-end: The description of the front-end architecture, user interface design, features, and functionalities of the front-end, and frameworks, libraries, and tools used.
- Back-end: The description of the back-end architecture, features and functionalities of the back-end, frameworks, libraries, tools used, and data models and database schema.
- API Design: The description of the API design, list of API endpoints, their functionalities, and sample API requests and responses.
- Deployment: The description of the deployment process, hosting environment and infrastructure, and deployment scripts and configuration.
- Testing: The description of the testing process, types of testing, test frameworks and tools used.
- Future Enhancements: The list of potential future enhancements to the platform, explanation of how these enhancements would improve the platform, estimated timeline and priority for implementing these enhancements.
In summary, StudyNotion is a versatile and intuitive ed-tech platform that is designed to provide an immersive learning experience to students and a platform for instructors to showcase their expertise. In the following sections, we will delve into the technical details of the platform, which will provide a comprehensive understanding of the platform's features and functionalities.
- HTML:HTML (HyperText Markup Language) is a skeleton of a website, structuring content with tags and elements.
- CSS:CSS is a style sheet language used to style web pages.It enables the application of different styles based on media types and user preferences, enhancing user accessibility and readability
- JavaScript:JavaScript is a programming language used to add interactivity to websites.
- React.js:A JavaScript library for building user interfaces. It allows developers to create large web applications that can update and render efficiently in response to data changes.
- MongoDB: A NoSQL database that provides high performance, high availability, and easy scalability. It stores data in flexible, JSON-like documents.
- Express.js: A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
- Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine, enabling server-side scripting and running scripts server-side to produce dynamic web page content.
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.
The front end of the platform is built using ReactJS, ReactJS allows for the creation of dynamic and responsive user interfaces, which are critical for providing an engaging learning experience to the students. The front end communicates with the back end using RESTful API calls
The back end of the platform is built using NodeJS and ExpressJS,. 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.
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. The database stores the course content, user data, and other relevant information related to the platform.
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:
- Homepage: This page will have a brief introduction to the platform, as well as links to the course list and user details.
- Course List: This page will have a list of all the courses available on the platform, along with their descriptions and ratings.
- Wishlist: This page will display all the courses that a student has added to their wishlist.
- Cart Checkout: This page will allow the user to complete the course purchase.
- Course Content: This page will have the course content for a particular course, including videos, and other related material.
- User Details: This page will have details about the student's account, including their name, email, and other relevant information.
- User Edit Details: This page will allow the student to edit their account details.
- Dashboard: This page will have an overview of the instructor's courses, as well as the ratings and feedback for each course.
- Insights: This page will have detailed insights into the instructor's courses, including the number of views, clicks, and other relevant metrics.
- Course Management Pages: These pages will allow the instructor to create, update, and delete courses, as well as manage the course content and pricing.
- View and Edit Profile Details: These pages will allow the instructor to view and edit their account details. PAGE 3 For Admin (this is for future scope):
- Dashboard: This page will have an overview of the platform's courses, instructors, and students.
- Insights: This page will have detailed insights into the platform's metrics, including the number of registered users, courses, and revenue.
- Instructor Management: This page will allow the admin to manage the platform's instructors, including their account details, courses, and ratings.
- Other Relevant Pages: The admin will also have access to other relevant pages, such as user management and course management pages.
To build the front end, we use frameworks and libraries such as ReactJS, We also use CSS and Tailwind, which are styling frameworks that help make the user interface look good and responsive. To manage the state of the application, we use Redux, which is a popular state management library for React.
Description of the Back-end Architecture: StudyNotion uses a monolithic architecture, with the backend built using Node.js and Express.js, and MongoDB as the primary database.
Features and Functionalities of the Back-end: The back end of StudyNotion provides a range of features and functionalities, including:
- User authentication and authorization: Students and instructors can sign up and log in to the platform using their email addresses and password. 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 enrol on courses by completing the checkout flow that is 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, which allows for easier display and rendering on the front end.
Frameworks, Libraries, and Tools used: The back end of StudyNotion uses a range of frameworks, libraries, and tools to ensure its functionality and performance, including:
- Node.js: Node.js is used as the primary framework for the back end.
- MongoDB: MongoDB is used as the primary database, providing a flexible and scalable data storage solution.
- Express.js: Express.js is used as a web application framework, providing a range of features and tools for building web applications.
- JWT: JWT (JSON Web Tokens) are used for authentication and authorization, providing a secure and reliable way to manage user credentials.
- Bcrypt: Bcrypt is used for password hashing, adding an extra layer of security to user data.
- Mongoose: Mongoose is used as an Object Data Modeling (ODM) library, providing a way to interact with MongoDB using JavaScript
The back end of StudyNotion uses a range of 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.
Overall, the back-end of StudyNotion is designed to provide a robust and scalable solution for an ed-tech platform, with a focus on security, reliability, and ease of use. By using the right frameworks, libraries, and tools, we can ensure that the platform functions smoothly and provides an optimal user experience for all its users.
The StudyNotion platform's API is designed following the REST architectural style. The API is implemented using Node.js and Express.js. It uses JSON for data exchange and follows standard HTTP request methods such as GET, POST, PUT, and DELETE. Sample list of API endpoints and their functionalities:
- /api/auth/signup (POST) - Create a new user (student or instructor) account.
- /api/auth/login (POST) – Log in using existing credentials and generate a JWT token.
- /api/auth/verify-otp (POST) - Verify the OTP sent to the user's registered email.
- /api/auth/forgot-password (POST) - Send an email with a password reset link to the registered email.
- /api/courses (GET) - Get a list of all available courses.
- /api/courses/:id (GET) - Get details of a specific course by ID.
- /api/courses (POST) - Create a new course.
- /api/courses/:id (PUT) - Update an existing course by ID.
- /api/courses/:id (DELETE) - Delete a course by ID.
- /api/courses/:id/rate (POST) - Add a rating (out of 5) to a course. Sample API requests and responses:
- GET /api/courses: Get all courses
- Response: A list of all courses in the database
- GET /api/courses/:id: Get a single course by ID
- Response: The course with the specified ID
- POST /api/courses: Create a new course
- Request: The course details in the request body
- Response: The newly created course
- PUT /api/courses/:id: Update an existing course by ID
- Request: The updated course details in the request body
- Response: The updated course
- DELETE /api/courses/:id: Delete a course by ID
- Response: A success message indicating that the course has been deleted.
In conclusion, the REST API design for the StudyNotion ed-tech platform is a crucial part of the project. The API endpoints and their functionalities are designed to ensure seamless communication between the front-end and back-end of the application. By following RESTful principles, the API will be scalable, maintainable, and reliable. The sample API requests and responses provided above illustrate how each endpoint will function and what kind of data it will accept or return. With this API design, StudyNotion will be able to provide a smooth user experience while ensuring security and stability.
To get started with StudyNotion on your local machine, follow these steps:
Before you begin, ensure you have the following prerequisites installed:
-
Node.js (version X.X.X) ⚙️
-
MongoDB (version X.X.X) 📦
-
Git 📂
-
Clone the Repository:
git clone https://github.com/yourusername/StudyNotion-An-Online-Education-Platform.git
-
Navigate to the Project Directory:
cd StudyNotion-An-Online-Education-Platform -
Install Dependencies:
npm install
-
Set Environment Variables:
cd serverCreate a
.envfile or rename it to.envif exists already in server for the following environment variables:PORT = 4000 MONGODB_URL = # Nodemailer MAIL_HOST = smtp.gmail.com MAIL_USER = MAIL_PASS = #*Controllers #login JWT_SECRET = #cloudinary CLOUD_NAME = API_KEY = API_SECRET = FOLDER_NAME = "StudyNotion" #*Config #Razorpay RAZORPAY_KEY = RAZORPAY_SECRET =
1] Keep the port number as it is.
2] For MONGODB_URL follow below steps –
- If you want to connect db locally replace MONGO_URI with
mongodb://localhost:27017/db_name, Where db_name is the database name, you can give yours. - If you want to connect using MONGO_ATLAS, then do the following steps
-
Signup or login for Mongo DB atlas via https://account.mongodb.com/account/register?_ga=2.174802465.288724901.1646250007-570639881.1643975138
-
Once you login, click on create button
-
Again, click on Create Cluster Button
-
Wait for few minutes, and then following dashboard will appear
-
Click on connect and choose your application.
-
Copy the URL and add your name and password in url, which you have set when creating cluster, and put it .env file.
-
3] For NodeMailer follow below steps –
- By default, Gmail prevents bots from accessing emails hosted on Google servers. Gmail runs several checks to ensure that every email account is accessed by a recognized user at a recognized location.
- Google requires your account to have two-factor authentication (2FA) enabled to connect it to Nodemailer.
- We’ll also need to set up an app password. To do so, follow these steps:
- Make sure you’re logged in to your Gmail account
- Under How you sign in to Google, select 2-Step Verification
- You’ll be prompted to sign in to your email again
- Scroll down to App passwords and click the arrow, >
- In the Select app dropdown, select your app or enter a custom name, then do the same for the Select device dropdown
- Click Generate, and a modal will pop up with your 16-digit app password.Copy it to somewhere secure
Now, Finally put your email in MAIL_USER & app password in MAIL_PASS in .env file. It is necessary, unless you will not receive OTP on your mail.
4] For JWT_SECRET follow the below steps –
- This is typically a secret key used for JWT (JSON Web Token) authentication in your application.
- You can generate a random string using a tool like crypto in Node.js. For example:
const crypto = require('crypto'); const jwtSecret = crypto.randomBytes(32).toString('hex'); console.log(jwtSecret);
- Copy the generated string and paste it as the value for JWT_SECRET in your .env file.
5] For Cloudinary follow the below steps –
- Sign Up for Cloudinary: Go to the Cloudinary website (https://cloudinary.com) and sign up for an account. You can choose the free plan to get started.
- Access Dashboard: After signing up and logging in, you'll be redirected to your Cloudinary dashboard.
- Find Your Cloud Name: Your Cloudinary cloud name is displayed on the dashboard. It's usually in the format [your_cloud_name]. Copy this value.
- Generate API Key and API Secret: In the Cloudinary dashboard, navigate to the "Account Details" or "Dashboard" section. Here, you'll find your API key and API secret. If you don't see them, you may need to generate them. Look for an option like "API Credentials" or "API Key & Secret".
- If you need to generate API key and secret, click on the appropriate button/link and Cloudinary will provide you with the key and secret.
- If they are already provided, simply copy them.
- Now that you have your Cloudinary “CLOUD_NAME”, “API_KEY”, and “API_SECRET”, you can set them up in your .env file as described earlier. CLOUD_NAME=your_cloud_name API_KEY=your_api_key API_SECRET=your_api_secret
6] For Razorpay follow the below steps-
- Log in to your Dashboard with appropriate credentials.
- Select the mode (Test or Live) for which you want to generate the API key.
- Select the
test modefor project. - Test Mode: The test mode is a simulation mode that you can use to test your integration flow. Your customers will not be able to make payments in this mode.
- Navigate to Account & Settings → API Keys (under Website and app settings) → Generate Key to generate key for the selected mode.
- The “Key Id” and “Key Secret” appear on a pop-up page. you can set them up in your .env file as described earlier. RAZORPAY_KEY = “your_razorpay_key” RAZORPAY_SECRET = “your_razorpay_secret”
- If you want to connect db locally replace MONGO_URI with
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
This project is part of GirlScript Summer of Code. We enthusiastically invite contributions from the community to help elevate StudyNotion to new heights.
Thank you for your invaluable contributions to our project! Your support is immensely appreciated in enhancing StudyNotion. 😊