Update README.md

Readme update

README.md

@@ -1 +1,66 @@
-.
+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.
+
+
+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, 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.
+
+Front-End
+For Students:
+
+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.
+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.
+
+
+For Instructors:
+
+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.
+
+Back-end
+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. Monolithic architecture refers to a design approach where all the modules of the application are combined into a single large program, with a single codebase, to enable better control, security, and performance.
+Node.js is a popular JavaScript runtime that allows us to run JavaScript code outside of the browser. Express.js is a web application framework that simplifies the process of building web applications in Node.js. MongoDB is a popular NoSQL database that allows for flexible data storage and retrieval, making it a suitable choice for complex applications like StudyNotion.
+
+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.
+Kindly check your Spam Box for emails.
+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.
+
+
+Deployment:
+The deployment process for the StudyNotion ed-tech platform will involve hosting the application on various cloud-based services. The front end will be deployed using Vercel, a popular hosting service for static sites built with React. The back-end will be hosted on Render or Railway, two cloud-based hosting services for applications built with Node.js and MongoDB. Media files will be hosted on Cloudinary, a cloud-based media management platform, and the database will be hosted on MongoDB Atlas, a fully managed cloud database service.
+
+The hosting environment and infrastructure for the StudyNotion platform will ensure scalability, security, and reliability. Vercel provides a fast and scalable hosting environment for the front end, while Render or Railway provide a scalable and reliable infrastructure for the back end. Cloudinary provides reliable storage for media files with features like automatic image optimization and transformation, while MongoDB Atlas provides a highly available and secure database environment with features like automatic scaling and disaster recovery. 
+
+NOTE:
+I've created this Project From Tutorials of love Babar . Initially I thought of building the same project then using it's resourses for E-commerce project but, this project itself was so large and comprehensive. It consumed a lot of time for debugging codebase and due to time constraint I Could not do things accourding to my plan
+