If you appreciate my work, please 🌟 this repository. It motivates me. 🚀🚀
Live Website: 💡 StudyNotion »
Explore the Documentation: 📝 Explore the Docs »
Figma File: 💄 Explore the Designs »
Table of Contents
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.
To get a local copy up and running follow these simple example steps.
- Get a free API Key from Cloudinary and Razorpay
- Clone the repo
git clone https://github.com/Rushik-Ghuntala/StudyNotion-EdTech-Platform.git
- Go to the
cd server/
- Make .env File and give key and values as .env.sample File difined
- Install NPM packages in server file
npm install
- Go to the root file
cd ..
- Make .env File and give key and values as .env.sample File difined
- Install NPM packages in root file
npm install
- Run the Project from root file
npm run dev