Skip to content

Latest commit

 

History

History
118 lines (86 loc) · 3.76 KB

README.md

File metadata and controls

118 lines (86 loc) · 3.76 KB

🏡 Lodgify - Travel & Listings Platform

Lodgify Banner

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. 🌍✨

🌐 Live Project

Check it out here: https://lodgify-e4uq.onrender.com

🚀 Key Features

✅ Full CRUD Operations: Create, Read, Update, and Delete listings effortlessly.
✅ Interactive Maps: Each listing includes a Leaflet API powered map.
✅ User Reviews: Share experiences and feedback on listings.
✅ REST API & AJAX: Optimized performance with smooth interactions.
✅ Passport Authentication: User login handled securely using Passport.js.
✅ Session Management with Cookies: Maintains user sessions using cookies.
✅ MVC Architecture: Well-structured and scalable codebase.
✅ Mobile-Responsive Design: Powered by Bootstrap for a great experience on all devices.

🎨 Tech Stack

🖥️ Frontend

  • HTML5
  • CSS3
  • JavaScript
  • Bootstrap

⚙️ Backend

  • Node.js
  • Express.js
  • RESTful API
  • AJAX
  • Passport.js (for authentication)
  • Cookie-based session storage

🗄️ Database

  • MongoDB

🛠️ Other Technologies

  • MVC Framework
  • Leaflet API (for maps)
  • JSON Web Tokens (JWT) for API authentication

📁 Project Structure

The project follows the MVC pattern with organized folders for scalability:

Lodgify/
├── .vscode/           # VS Code specific settings
├── controllers/       # Controller logic for routing
├── init/              # Initialization scripts/configs
├── models/            # Mongoose models (schemas)
├── public/            # Static assets (images, CSS, JS)
├── routes/            # Express route definitions
├── utils/             # Utility/helper functions
├── views/             # EJS or other view templates
├── .gitignore         # Git ignored files list
├── LICENSE            # MIT License file
├── README.md          # Project documentation
├── app.js             # Entry point of the app
├── cloudconfig.js     # Cloud service configurations
├── middleware.js      # Custom middleware functions
├── package-lock.json  # Exact dependency tree
├── package.json       # Project metadata and scripts
├── schema.js          # Additional schema definitions

🚀 Getting Started

  1. Clone the repository:

    git clone https://github.com/deepaksoni47/Lodgify.git
cd Lodgify

  2. Install dependencies:

    npm install

  3. Start the development server:

    node app.js

🤝 Contributing

We welcome contributions! If you have suggestions or improvements, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Make your changes and commit them (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a pull request.
  6. Ensure your code adheres to the project's coding standards and passes all tests.
  7. Add relevant documentation for any new features or changes.
  8. If applicable, add tests for your changes.

📜 License

Lodgify is licensed under the MIT License.

📬 Contact

📌 GitHub: deepaksoni47
📌 Email: deepaksoni23022004@gmail.com

🌟 If you like this project, don’t forget to give it a star! ⭐