|
| 1 | +# WindBnB |
| 2 | + |
| 3 | +A simple React and Vite web project inspired by Airbnb, built as a frontend exercise to explore component-based UI, responsive layouts, and state handling. |
| 4 | +Originally created as part of a course and later extended for further learning and experimentation. |
| 5 | + |
| 6 | +## π Tech Stack |
| 7 | +- React (functional components with Hooks) |
| 8 | +- Vite (development server and build tool) |
| 9 | +- JavaScript and CSS |
| 10 | +- Purely frontend with no backend dependencies |
| 11 | + |
| 12 | +## π― Features |
| 13 | +- Displays property listings with images and details |
| 14 | +- Includes basic filtering and sorting |
| 15 | +- Uses a responsive layout that adapts to desktop and mobile |
| 16 | +- Modular structure that is easy to extend with new features such as authentication or API integration |
| 17 | + |
| 18 | +## π¦ Getting Started |
| 19 | +1. Clone the repository |
| 20 | + ```bash |
| 21 | + git clone https://github.com/travisdk/windbnb.git |
| 22 | + cd windbnb |
| 23 | + |
| 24 | + Install dependencies |
| 25 | + |
| 26 | +npm install |
| 27 | + |
| 28 | +Start the development server |
| 29 | + |
| 30 | +npm run dev |
| 31 | + |
| 32 | +Open the local address shown in your terminal (usually http://localhost:5173). |
| 33 | + |
| 34 | +Build for production |
| 35 | + |
| 36 | + npm run build |
| 37 | + |
| 38 | + The production-ready files are located in the dist folder and can be hosted on GitHub Pages, Netlify, or Vercel. |
| 39 | + |
| 40 | +π Project Structure |
| 41 | + |
| 42 | +src/ β Components, styles, and logic |
| 43 | +public/ β Static assets and index.html |
| 44 | +res/ β Images and extra resources |
| 45 | +vite.config.js β Vite configuration |
| 46 | + |
| 47 | +π§ Possible Extensions |
| 48 | + |
| 49 | + Connect to a real backend (Node.js, ASP.NET Core, Firebase, or similar) |
| 50 | + |
| 51 | + Add user authentication |
| 52 | + |
| 53 | + Implement booking flow or user reviews |
| 54 | + |
| 55 | + Integrate a live API for property listings |
| 56 | + |
| 57 | +π Notes |
| 58 | + |
| 59 | +This project began as a course assignment and was later customized to improve structure, styling, and usability. |
| 60 | +It serves as a small showcase of modern frontend practices using React and Vite. |
0 commit comments