|
| 1 | + |
| 2 | +# 🏡 Lodgify - Travel & Listings Platform |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | +> **Discover, List, and Explore!** Lodgify is a **travel and listings website** where users can view property details, add their own listings, and leave reviews. Built with an intuitive UI and a robust backend, Lodgify ensures a seamless experience for travelers and property owners alike. 🌍✨ |
| 7 | +
|
| 8 | +## 🌐 Live Project |
| 9 | + |
| 10 | +Check it out here: [https://lodgify-e4uq.onrender.com](https://lodgify-e4uq.onrender.com) |
| 11 | + |
| 12 | +## 🚀 Key Features |
| 13 | + |
| 14 | +✅ **Full CRUD Operations**: Create, Read, Update, and Delete listings effortlessly. |
| 15 | +✅ **Interactive Maps**: Each listing includes a **Leaflet API** powered map. |
| 16 | +✅ **User Reviews**: Share experiences and feedback on listings. |
| 17 | +✅ **REST API & AJAX**: Optimized performance with smooth interactions. |
| 18 | +✅ **Passport Authentication**: User login handled securely using **Passport.js**. |
| 19 | +✅ **Session Management with Cookies**: Maintains user sessions using cookies. |
| 20 | +✅ **MVC Architecture**: Well-structured and scalable codebase. |
| 21 | +✅ **Mobile-Responsive Design**: Powered by **Bootstrap** for a great experience on all devices. |
| 22 | + |
| 23 | +## 🎨 Tech Stack |
| 24 | + |
| 25 | +### 🖥️ Frontend |
| 26 | + |
| 27 | +- HTML5 |
| 28 | +- CSS3 |
| 29 | +- JavaScript |
| 30 | +- Bootstrap |
| 31 | + |
| 32 | +### ⚙️ Backend |
| 33 | + |
| 34 | +- Node.js |
| 35 | +- Express.js |
| 36 | +- RESTful API |
| 37 | +- AJAX |
| 38 | +- Passport.js (for authentication) |
| 39 | +- Cookie-based session storage |
| 40 | + |
| 41 | +### 🗄️ Database |
| 42 | + |
| 43 | +- MongoDB |
| 44 | + |
| 45 | +### 🛠️ Other Technologies |
| 46 | + |
| 47 | +- MVC Framework |
| 48 | +- Leaflet API (for maps) |
| 49 | +- JSON Web Tokens (JWT) for API authentication |
| 50 | + |
| 51 | +## 📂 Project Structure |
| 52 | + |
| 53 | +\`\`\` |
| 54 | +Lodgify/ |
| 55 | +│-- backend/ # Node.js Express API |
| 56 | +│-- frontend/ # HTML, CSS, JavaScript UI |
| 57 | +│-- docs/ # API Documentation |
| 58 | +│-- tests/ # Unit and integration tests |
| 59 | +│-- README.md # Project documentation |
| 60 | +\`\`\` |
| 61 | + |
| 62 | +## 🚀 Getting Started |
| 63 | + |
| 64 | +1. **Clone the repository**: |
| 65 | + \`\`\`sh |
| 66 | + git clone https://github.com/deepaksoni47/Lodgify.git |
| 67 | + cd Lodgify |
| 68 | + \`\`\` |
| 69 | + |
| 70 | +2. **Install dependencies**: |
| 71 | + \`\`\`sh |
| 72 | + npm install |
| 73 | + \`\`\` |
| 74 | + |
| 75 | +3. **Start the development server**: |
| 76 | + \`\`\`sh |
| 77 | + node app.js |
| 78 | + \`\`\` |
| 79 | + |
| 80 | +## 🤝 Contributing |
| 81 | + |
| 82 | +We welcome contributions! If you have suggestions or improvements, please follow these steps: |
| 83 | + |
| 84 | +1. Fork the repository. |
| 85 | +2. Create a new branch (\`git checkout -b feature/YourFeature\`). |
| 86 | +3. Make your changes and commit them (\`git commit -m 'Add some feature'\`). |
| 87 | +4. Push to the branch (\`git push origin feature/YourFeature\`). |
| 88 | +5. Open a pull request. |
| 89 | +6. Ensure your code adheres to the project's coding standards and passes all tests. |
| 90 | +7. Add relevant documentation for any new features or changes. |
| 91 | +8. If applicable, add tests for your changes. |
| 92 | + |
| 93 | +## 📜 License |
| 94 | + |
| 95 | +Lodgify is licensed under the [MIT License](LICENSE). |
| 96 | + |
| 97 | +## 📬 Contact |
| 98 | + |
| 99 | +📌 **GitHub**: [deepaksoni47](https://github.com/deepaksoni47) |
| 100 | +📌 **Email**: deepaksoni23022004@gmail.com |
| 101 | + |
| 102 | +--- |
| 103 | + |
| 104 | +🌟 **If you like this project, don’t forget to give it a star!** ⭐ |
0 commit comments