Skip to content

Commit 7a12bd9

Browse files
authored
Create README.md
1 parent 08b6301 commit 7a12bd9

1 file changed

Lines changed: 96 additions & 0 deletions

File tree

README.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<div align="center">
2+
<h1>🚀 CODEGYAAN2</h1>
3+
<p><i>Empowering Innovation, Transforming Learning Experiences</i></p>
4+
5+
<img src="https://img.shields.io/badge/Built%20With-React-blue?style=for-the-badge" />
6+
<img src="https://img.shields.io/badge/Backend-Node.js-green?style=for-the-badge" />
7+
<img src="https://img.shields.io/badge/Database-MongoDB-brightgreen?style=for-the-badge" />
8+
<img src="https://img.shields.io/badge/Authentication-OTP%20&%20JWT-orange?style=for-the-badge" />
9+
<img src="https://img.shields.io/badge/Payments-Razorpay-purple?style=for-the-badge" />
10+
</div>
11+
12+
---
13+
14+
## 🧰 Built With
15+
16+
<div align="center">
17+
18+
![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react)
19+
![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js)
20+
![Express.js](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express)
21+
![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb)
22+
![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css)
23+
![Razorpay](https://img.shields.io/badge/Razorpay-02042B?style=for-the-badge&logo=razorpay)
24+
![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)
25+
![Cloudinary](https://img.shields.io/badge/Cloudinary-3448C5?style=for-the-badge&logo=cloudinary)
26+
27+
</div>
28+
29+
---
30+
31+
## 📚 Table of Contents
32+
33+
- [🔍 Overview](#-overview)
34+
- [🚀 Getting Started](#-getting-started)
35+
- [🧱 Prerequisites](#-prerequisites)
36+
- [🔧 Installation](#-installation)
37+
- [🧪 Testing](#-testing)
38+
- [📈 Usage](#-usage)
39+
- [🙌 Contribution](#-contribution)
40+
- [📬 Contact](#-contact)
41+
42+
---
43+
44+
## 🔍 Overview
45+
46+
**CodeGyaan2** is your all-in-one open-source powerhouse designed for building modern, scalable online learning platforms. Whether you're building for students, instructors, or admins, it delivers a robust, feature-rich experience with a sleek UI and bulletproof backend.
47+
48+
### ✨ Core Features
49+
50+
- ⚙️ **Modular Architecture**
51+
Clean separation of frontend and backend = effortless customization and scaling.
52+
53+
- 🔐 **Secure Authentication**
54+
Role-based access, OTP login, and JWT tokens keep your users locked in (safely).
55+
56+
- 💳 **Payment Integration**
57+
Razorpay support for smooth, secure transactions with no fuss.
58+
59+
- 🖼️ **Media Management**
60+
Cloudinary handles image/video uploads like a pro.
61+
62+
- ⚒️ **Developer Utilities**
63+
Built-in API connectors, custom hooks, and state management streamline development.
64+
65+
---
66+
67+
## 🚀 Getting Started
68+
69+
Clone the repo and kick off your own version of CodeGyaan2 in minutes.
70+
71+
### 🧱 Prerequisites
72+
73+
Make sure you have the following installed:
74+
75+
- Node.js
76+
- NPM
77+
78+
---
79+
80+
## 🔧 Installation
81+
82+
Follow these steps to set up the project:
83+
84+
# Clone the repository
85+
git clone https://github.com/your-username/codegyaan2.git
86+
cd codegyaan2
87+
88+
# Backend Setup
89+
cd backend
90+
npm install
91+
npm run dev
92+
93+
# Frontend Setup
94+
cd ../frontend
95+
npm install
96+
npm start

0 commit comments

Comments
 (0)