Skip to content

Commit 07ef9b0

Browse files
Update README.md
1 parent 81a5643 commit 07ef9b0

1 file changed

Lines changed: 179 additions & 89 deletions

File tree

README.md

Lines changed: 179 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# ZenVedaSync - Course Website Project
1+
# ZenVedaSync - E-Learning Website
22

33
## Project Overview
4-
ZenVedaSync is a cutting-edge course website designed to blend the ancient wisdom of Indian Vedas with modern technology, catering to the Gen Z audience. This platform offers a range of free and premium courses, featuring coin-based rewards, secure payment options, user authentication, and detailed progress tracking.
4+
ZenVedaSync is an innovative e-learning platform that merges the ancient wisdom of Indian Vedas with modern technology, specifically designed for the Gen Z audience. The site offers a diverse selection of free and premium courses, featuring secure payment options, user authentication, and comprehensive progress tracking to enhance the learning experience.
5+
56

67
**CSE-D**
78

@@ -43,50 +44,92 @@ ZenVedaSync is a cutting-edge course website designed to blend the ancient wisdo
4344
- **PhpMyAdmin**: Database administration tool
4445

4546
## Project Structure
47+
```
4648
### Backend Directory (PHP)
49+
backend/
50+
├── auth/
51+
│ ├── forgot-password.php
52+
│ ├── login.php
53+
│ ├── logout.php
54+
│ ├── register.php
55+
│ └── reset_process.php
56+
├── payment/
57+
│ ├── payment-success.php
58+
│ └── payment.php
59+
├── phpmailer/
60+
├── config.php
61+
├── contact.php
62+
├── course-detail.php
63+
├── courses.php
64+
├── dashboard-teacher.php
65+
├── dashboard.php
66+
├── edit-course.php
67+
├── enroll.php
68+
├── free-courses.php
69+
├── paid-courses.php
70+
└── video-player.php
71+
```
72+
73+
## Frontend Directory
74+
4775
```
48-
backend/
49-
├── api/
50-
│ ├── courses/
51-
│ ├── auth/
52-
│ ├── users/
53-
│ ├── payments/
54-
│ ├── coins/
55-
│ ├── config/
56-
│ └── index.php
57-
```
58-
59-
### Frontend Directory
60-
```
61-
frontend/
62-
├── css/
63-
│ ├── tailwind.css
64-
│ ├── main.css
65-
├── js/
66-
│ ├── script.js
67-
├── images/
68-
├── index.html
69-
├── home.html
70-
├── login.html
71-
├── register.html
72-
├── courses.html
73-
├── course-detail.html
74-
├── dashboard.html
75-
├── payment.html
76-
├── support.html
77-
├── faq.html
78-
├── contact.html
79-
├── terms.html
80-
├── privacy.html
81-
├── about.html
82-
├── blog.html
83-
├── press.html
84-
├── apply.html
85-
├── job-details.html
86-
├── submit-ticket.html
87-
├── tutorials.html
88-
├── career.html
89-
└── know-us.html
76+
frontend/
77+
├── Pages/
78+
│ ├── Auth/
79+
│ │ ├── Forgot-Password.html
80+
│ │ ├── Login.html
81+
│ │ └── SignUp.html
82+
│ ├── Courses/
83+
│ │ ├── course-details.html
84+
│ │ ├── free-courses.html
85+
│ │ └── paid-course.html
86+
│ ├── Progress-Tracking/
87+
│ │ ├── Progress-Tracking.css
88+
│ │ ├── Progress-Tracking.html
89+
│ │ └── Progress-Tracking.js
90+
│ ├── Support-FAQ/
91+
│ │ ├── FAQ.html
92+
│ │ └── Support.html
93+
│ ├── Video-Player/
94+
│ │ ├── Video-Player.css
95+
│ │ ├── Video-Player.html
96+
│ │ └── Video-Player.js
97+
│ ├── blogs/
98+
│ │ ├── blog-post-1.html
99+
│ │ ├── blog-post-2.html
100+
│ │ ├── blog-post-3.html
101+
│ │ └── blog.html
102+
│ ├── Payment.html
103+
│ ├── Privacy-Policy.html
104+
│ ├── Testimonial.html
105+
│ ├── about-us.html
106+
│ ├── apply.html
107+
│ ├── careers.html
108+
│ ├── contact-us.html
109+
│ ├── dashboard-teacher.html
110+
│ ├── dashboard.html
111+
│ ├── edit-course.html
112+
│ ├── help-center.html
113+
│ ├── job-details.html
114+
│ ├── know-us.html
115+
│ ├── press.html
116+
│ ├── submit-a-ticket.html
117+
│ ├── terms-and-conditions.html
118+
│ ├── tutorials.html
119+
├── Scripts/
120+
│ ├── script.js
121+
│ └── validPaths.json
122+
├── Styles/
123+
│ ├── Styles.css
124+
│ ├── header-footer.css
125+
├── images/
126+
│ ├── 404.html
127+
│ ├── footer.html
128+
│ ├── header.html
129+
│ ├── index.html
130+
├── .gitignore
131+
├── README.md
132+
└── package.json
90133
```
91134

92135
## Setup and Installation
@@ -96,61 +139,108 @@ frontend/
96139
- MySQL
97140
- PhpMyAdmin
98141

99-
### Backend (PHP) Setup
100-
1. Clone the repository:
101-
```bash
102-
git clone https://github.com/Meetmendapara09/WT-Try.git
103-
cd course-website/backend
142+
## Backend (PHP) Setup
143+
144+
### 1. Clone the repository:
104145
```
146+
git clone https://github.com/Meetmendapara09/Web_Technology.git
147+
cd Web_Technology/BackEnd
148+
```
149+
### 2. Set up the database:
150+
```
151+
Create a database named course_website.
152+
Import backend/config/db.sql into your MySQL database.
153+
Update database configuration in backend/config/db.php.
154+
```
105155

106-
2. Set up the database:
107-
- Create a database named `course_website`.
108-
- Import `backend/config/db.sql` into your MySQL database.
156+
### 3. Start the PHP server:
157+
```
158+
php -S localhost:8000
159+
```
109160

110-
3. Update database configuration in `backend/config/db.php`.
161+
### 4. Frontend Setup
162+
Navigate to the frontend directory:
163+
```
164+
cd ../frontend
165+
```
166+
Open index.html in a web browser to view the site.
111167

112-
4. Start the PHP server:
113-
```bash
114-
php -S localhost:8000
115-
```
168+
## Usage
116169

117-
### Frontend Setup
118-
1. Navigate to the frontend directory:
119-
```bash
120-
cd ../frontend
121-
```
170+
Access the frontend at
171+
```
172+
http://localhost:8000/
173+
```
174+
The backend is available at
175+
```
176+
http://localhost:3307/
122177
123-
2. Open `index.html` in a web browser to view the site.
178+
```
179+
180+
## Running the Backend with XAMPP
181+
- **Install XAMPP**: Download and install XAMPP from Apache Friends.
182+
183+
- **Start XAMPP:** Open the XAMPP Control Panel and start Apache and MySQL.
184+
185+
- **Clone the Repository**:
186+
187+
Go to the htdocs folder in your XAMPP installation
188+
```
189+
(usually C:\xampp\htdocs).
190+
```
191+
- **Clone the repository**:
192+
```
193+
git clone https://github.com/Meetmendapara09/Web_Technology.git
194+
```
195+
196+
- **Set Up the Database**:
197+
198+
Open your web browser and go to
199+
```
200+
http://localhost/phpmyadmin.
201+
```
202+
- Create a new database named course_website.
203+
- Import the SQL file (if available) to set up tables.
204+
- Configure Database Connection:
205+
Open the config.php file in the backend folder.
206+
Update the database details:
207+
```
208+
$servername = "localhost";
209+
$username = "root"; // Default XAMPP username
210+
$password = ""; // Default XAMPP password is empty
211+
$dbname = "ZenVedaSync";
212+
```
213+
214+
Access the Backend:
215+
216+
Open your browser and go to:
217+
```
218+
http://localhost/Web_technology/BackEnd
219+
```
220+
Test: Check different functionalities like login and registration.
221+
222+
223+
### Payment Integration and Deployment
224+
To set up payment processing and integration, please visit the following website to obtain your keys:
225+
226+
For more details, refer to the documentation:
227+
- **Gmail SMTP Documentation**: [Gmail SMTP Settings](https://support.google.com/a/answer/176600?hl=en)
228+
- **Razorpay API Documentation**: [Razorpay API Documentation](https://razorpay.com/docs/api/)
229+
230+
```
231+
SMTP_HOST= # Your SMTP host (e.g., smtp.example.com)
232+
SMTP_PORT= # SMTP port (e.g., 587 for TLS)
233+
SMTP_USERNAME= # Your SMTP username
234+
SMTP_PASSWORD= # Your SMTP password
235+
SMTP_SECURE= # Security protocol (e.g., tls or ssl)
236+
(Razorpay API Credentials)
237+
API_KEY= # Your Razorpay API Key
238+
API_SECRET= # Your Razorpay API Secret
239+
```
124240

125-
## Usage
126-
- Access the frontend at `http://localhost:8000`.
127-
- The backend API is available at `http://localhost:8000/api`.
128-
129-
## API Endpoints
130-
### Authentication
131-
- `POST /api/auth/login`: User login
132-
- `POST /api/auth/register`: User registration
133-
- `POST /api/auth/passwordRecovery`: Password recovery
134-
135-
### Courses
136-
- `GET /api/courses/getCourses`: List courses
137-
- `GET /api/courses/getCourseDetails`: Course details
138-
- `POST /api/courses/addCourse`: Add a course
139-
- `PUT /api/courses/updateCourse`: Update a course
140-
- `DELETE /api/courses/deleteCourse`: Delete a course
141-
142-
### Users
143-
- `GET /api/users/getUser`: Get user details
144-
- `PUT /api/users/updateUser`: Update user info
145-
- `DELETE /api/users/deleteUser`: Delete a user
146-
147-
### Payments
148-
- `POST /api/payments/processPayment`: Process payment
149-
- `GET /api/payments/getPaymentHistory`: Payment history
150241

151242
## Contributing
152243
Contributions are welcome! Please fork this repository and submit a pull request.
153244

154245
## License
155246
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
156-

0 commit comments

Comments
 (0)