💻Tech Stacks

Table of Contents 📒

• Introduction 👋
• Features 🌟
• Technology Used 📡
• Future Scope 🏆
• Quick Start 🚀
• Contribution 📡

🎧Introduction

Welcome👋

Welcome to the README for the DEV-G EdTech project

This 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. It aims to provide:

• Seamless Learning Experience: A seamless and interactive learning experience for students, making education more accessible and engaging.
• Instructor Platform: A platform for instructors to showcase their expertise and connect with learners across the globe.

Live Link : https://edtech-dev-g-frontend.vercel.app/

🎥 Video Demonstration : Dev-G

Features🌟

💥User, Instructor, and Admin Functions

• User Roles: Different user roles are supported, each with their own set of functionalities.
• Course Creation and Organization: Instructors can create courses, organize content, and manage course materials.
• User Account Creation: Users can create accounts with OTP verification for enhanced security.
• Course Purchasing: Users can conveniently purchase courses through the integrated Razorpay payment gateway.
• Security Enhancements: SHA-256 and HMAC algorithms are utilized to provide robust data security.

📍Technologies Used

Frontend:

• React: A JavaScript library for building user interfaces.

Backend:

• MongoDB: A NoSQL database for storing application data.
• Express.js: A web application framework for Node.js used for building APIs.
• Node.js: A JavaScript runtime environment for executing server-side code.

Payment Gateway:

• Razorpay: Integrated for secure payment processing ( Use UPI ID: "success@razorpay" for dummy payment process).

🎯 Future Scope

Admin Section

• 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.

Quick Start🚀

To set up the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/ashutoshgithubs/iemhacks_DEV-G.git
   

2. Navigate to the project directory: cd iemhacks_DEV-G

3. Install dependencies: npm install

4. Configure environment variables:

   • Rename .env.sample to .env.
   • Fill in your configuration details in the .env file.

5. Start the script: npm run dev ( This command will run both client ( src ) and server ).

6. Access the application in your web browser at http://localhost:3000.

🤠 Project Admin

Ashutosh Kumar

✴️ Contribution Guidelines

Fork the Repository

First, fork the repository to your GitHub account by clicking on the "Fork" button at the top-right corner of the repository page.

Set Up the Project

After forking the repository, clone it to your local machine and install dependencies:

Then, start the project.

Create your account on the website by signing up and become familiar with the interface and behaviour of the backend.

Create a New Branch

Before making any changes, create a new branch for your contributions:

Work on Issues

You can either create a new issue to request changes or work on existing issues. If you choose to work on an existing issue, comment on it to get assigned the gssoc24 label.

Make Changes and Commit

Make your changes, stage them, and commit with descriptive messages:

Push Changes to Your Fork

Push your changes to your forked repository:

Create a Pull Request

Once your changes are pushed, create a pull request by visiting your forked repository on GitHub. Compare and select the appropriate branches, give your PR a descriptive title and description, and submit it for review.

Review and Merge

Your pull request will be reviewed by the project admin (i.e. me) or project mentor. Make any requested changes and wait for approval. Once approved, your branch will be merged into the main codebase.

This Project is a part of GSSoC'24

Contributors 🌟

Thanks goes to these wonderful people ✨✨:

🙏 Support

Don't forget to leave a star ⭐️ for this project!
Thank you for being a part of the DEV-G.

Back to top ⬆