Skip to content

Commit d06438e

Browse files
authored
Update README.md
1 parent 82dfd75 commit d06438e

File tree

1 file changed

+156
-5
lines changed

1 file changed

+156
-5
lines changed

README.md

+156-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,159 @@
1-
# React + Vite
1+
# Viatour
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
A comprehensive tourism web interface featuring both a user side and an admin panel.
4+
<video width="1500" controls src="https://github.com/user-attachments/assets/65622f75-6d01-46fb-8009-718b3766454d" />
5+
## Live View On Your Tab
6+
Click Here For Live View: [Live Demo](https://worldtourbyviatour.vercel.app/)
7+
8+
## Table of Contents 📑
9+
10+
- [About](#about)
11+
- [Features](#features)
12+
- [Technologies Used](#technologies-used)
13+
- [Folder Structure](#folder-structure)
14+
- [Getting Started](#getting-started)
15+
- [Running the Project](#running-the-project)
16+
- [Deployment](#deployment)
17+
- [Contact](#contact)
18+
19+
## About
20+
21+
Viatour is a feature-rich web application designed for the tourism industry. It includes a user-friendly interface for tourists and a powerful admin panel for managing tours, bookings, and other essential aspects of a tourism business.
22+
23+
<div style="display: flex; gap: 25px;">
24+
<img width="45%" src="https://github.com/user-attachments/assets/d587d5a2-6318-494c-bbe9-311450ce62d5" alt="user-side" >
25+
<img width="45%" src="https://github.com/user-attachments/assets/3ba24745-997c-4570-8016-e4ca04510f3e" alt="admin-view" />
26+
</div>
27+
28+
## Features 🥇
29+
30+
### User Side
31+
- **Tour Listings**: Browse through various tours with detailed descriptions.
32+
- **Booking System**: Easy and secure tour booking process.
33+
- **Responsive Design**: Optimized for all devices, ensuring a seamless experience.
34+
- **Interactive Maps**: View tour locations on interactive maps.
35+
36+
### Admin Panel
37+
- **Tour Management**: Add, edit, and delete tour information.
38+
- **Booking Management**: View and manage bookings.
39+
- **User Management**: Manage user accounts and permissions.
40+
- **Analytics Dashboard**: View statistics and insights about tours and bookings.
41+
42+
## Technologies Used 🛠️
43+
44+
- **React.js**: For building the user interface.
45+
- **Tailwind CSS**: For styling the application.
46+
- **Vite**: For fast development and build processes.
47+
- **Vercel**: For deployment.
48+
49+
## Folder Structure 📂
50+
51+
```plaintext
52+
viatour/
53+
54+
├── public/
55+
│ │ ├── icon.png
56+
│ │ └── ...
57+
│ │
58+
├── src/
59+
│ ├── assets/
60+
│ │ ├── images/
61+
│ │ └── ...
62+
│ │
63+
│ ├── components/
64+
│ │ ├── UserSide/
65+
│ │ │ ├── Breadcrums.jsx
66+
│ │ │ ├── BolgCard.jsx
67+
│ │ │ └── InputFied.jsx
68+
│ │ │ └── .......
69+
│ │
70+
│ ├── pages/
71+
│ │ ├── UserSide/
72+
│ │ │ ├── HomePage.jsx
73+
│ │ │ ├── TourDetails.jsx
74+
│ │ │ └── ...
75+
│ │ │
76+
│ │ ├── AdminPanel/
77+
│ │ │ ├── Dashboard.jsx
78+
│ │ │ └── Booking.jsx
79+
│ │ │ └── ......
80+
│ │
81+
│ │ ├── routes/
82+
│ │ │ ├── App.jsx
83+
│ │
84+
│ │ ├── Common/
85+
│ │ │ ├── index.js
86+
│ │
87+
│ │ ├── Section/
88+
│ │ │ ├── Header.jsx
89+
│ │ │ ├── Hero.jsx
90+
│ │ │ ├── PictureGallery.jsx
91+
│ │ │ ├── Fillter.jsx
92+
│ │ │ ├── .....
93+
│ │ │ ├── Fotter.jsx
94+
│ │
95+
96+
├── .index.html
97+
├── .gitignore
98+
├── package.json
99+
├── README.md
100+
└── ...
101+
102+
103+
## Getting Started
104+
105+
To get a local copy up and running, follow these steps:
106+
107+
### Prerequisites
108+
109+
- Node.js and npm installed on your machine.
110+
111+
### Installation
112+
113+
1. Clone the repository:
114+
```bash
115+
git clone https://github.com/Usanaee/viatour.git
116+
```
117+
118+
2. Navigate to the project directory:
119+
120+
```bash
121+
cd viatour
122+
```
123+
124+
3. Install the dependencies:
125+
126+
```bash
127+
npm install
128+
```
129+
130+
### Running the Project
131+
132+
```bash
133+
npm run dev
134+
```
135+
136+
Open your browser and visit http://localhost:3000 to see the project in action.
137+
138+
139+
## Deployment
140+
141+
You can deploy this project using Vercel by doing following these steps:
142+
143+
1. Install Vercel CLI:
144+
```bash
145+
npm install -g vercel
146+
```
147+
148+
2. Deploy the project:
149+
```bash
150+
vercel
151+
152+
```
153+
154+
155+
## Authors
156+
157+
<h1>- Repository Made By Usama Naeem 🖤</h1>
4158

5-
Currently, two official plugins are available:
6159

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

0 commit comments

Comments
 (0)