Skip to content

Latest commit

 

History

History
120 lines (94 loc) · 9.28 KB

README.md

File metadata and controls

120 lines (94 loc) · 9.28 KB
Raw

 ▄█          ▄████████  ▄█     ▄████████      ▀█████████▄  ███▄▄▄▄   ▀█████████▄
███         ███    ███ ███    ███    ███        ███    ███ ███▀▀▀██▄   ███    ███
███         ███    ███ ███▌   ███    ███        ███    ███ ███   ███   ███    ███
███         ███    ███ ███▌  ▄███▄▄▄▄██▀       ▄███▄▄▄██▀  ███   ███  ▄███▄▄▄██▀
███       ▀███████████ ███▌ ▀▀███▀▀▀▀▀        ▀▀███▀▀▀██▄  ███   ███ ▀▀███▀▀▀██▄
███         ███    ███ ███  ▀███████████        ███    ██▄ ███   ███   ███    ██▄
███▌    ▄   ███    ███ ███    ███    ███        ███    ███ ███   ███   ███    ███
█████▄▄██   ███    █▀  █▀     ███    ███      ▄█████████▀   ▀█   █▀  ▄█████████▀
▀                             ███    ███

Experience LAIR: A Lord of the Rings-inspired Airbnb!

Discover LAIR, where the magic of Middle-earth meets modern travel. Immerse yourself in enchanting accommodations inspired by Tolkien's world. From Hobbit holes to Elven treehouses and Dwarven castles, find your perfect retreat. Unleash your wanderlust and explore breathtaking landscapes. Our exceptional hosts ensure an extraordinary journey. Join the fellowship at LAIR and let the adventure begin! Try it out on : https://lairbnb.cyclic.app/

User Path:

  1. Homepage: Upon entering the LAIR website, the homepage loads, showcasing a selection of exquisite properties available for rent.
  2. Property Details: Users can freely explore the loaded properties and access their detailed information, even without logging in or signing up.
  3. Sign Up: If a user decides to sign up for an account, they can do so by clicking on the "Sign Up" button. This action leads them to a form that requests their information.
  4. Form Submission: After filling in the required details, the user submits the form, creating their LAIR account.
  5. Login: Once signed up, the user can access their account by clicking on the "Login" button. This redirects them to the login page.
  6. User Profile: Upon successful login, the user is directed to their profile page. Here, they can view all the information they provided during sign-up.
  7. Property Booking: From the user profile or homepage, the user can browse through available properties and select the one they wish to book.
  8. Property Page: Upon selecting a property, the user is taken to the property's page. Here, they can find comprehensive details about the property, including amenities, location, availability, and pricing.
  9. Booking Initiation: The user decides to proceed with booking and clicks on the "Book Now" button.
  10. Login/Sign Up Prompt: If the user is not logged in, they will be prompted to log in or sign up to continue the booking process.
  11. Logged In: Once logged in, the user is redirected back to the property page, ready to proceed with booking.
  12. Rating and Commenting: On the property page, the user can rate and comment on the property based on their experience.
  13. Select Dates: The user chooses the desired dates for their stay, which then calculates the corresponding price.
  14. Booking Confirmation: After selecting the dates, the user can finalize the booking by clicking on the "Book" button.
  15. Checkout: The user is directed to the checkout page, where all the booking details, including selected dates and the total price, are displayed.
  16. Review and Checkout: The user reviews the details on the checkout page and confirms the booking by clicking on the "Checkout" button.
  17. Booking Completed: The user's booking is successfully completed, marking the end of the journey.

Technologies Used

  • Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine, allowing you to run JavaScript code on the server.
  • MongoDB: A NoSQL document database that provides high scalability, flexibility, and performance.
  • Mongoose: A MongoDB object modeling tool designed to work with Node.js and provide a simple and straightforward way to interact with MongoDB.
  • JavaScript: A programming language that enables dynamic and interactive web development.
  • Express: A fast and minimalist web application framework for Node.js, which provides a robust set of features for web and mobile applications.
  • Bootstrap: A popular CSS framework that helps you quickly design and customize responsive websites.
  • Handlebars (hbs): A templating engine that allows you to generate dynamic HTML pages by combining data and templates.

Contributing

We welcome contributions from the community to make this project even better. To contribute, please follow these guidelines:

  1. Fork the repository and create your branch from main.
  2. Install the project dependencies by running npm install.
  3. Make your changes and ensure that the project still builds and runs successfully.
  4. Write tests to cover any new features or changes.
  5. Run the test suite with npm test to make sure all tests pass.
  6. Commit your changes and push your branch to your forked repository.
  7. Open a pull request against the main branch of this repository.
  8. Provide a clear and descriptive title for your pull request, along with a detailed description of the changes you made.
  9. Our team will review your contribution and provide feedback if needed. We may ask for some changes or improvements before merging.
  10. Once your pull request is approved and merged, we will credit you for your contribution.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dependencies

  • dotenv
  • express
  • mongoose
  • multer
  • helmet
  • path
  • hbs
  • bcrypt
  • express-session
  • connect-mongo
  • loader
  • jsonwebtoken
  • cookie-parser

Team Members

  • Roman
  • Filipa
  • Florian

Future Enhancements

While this user path covers the primary functionalities of the LAIR website, we are continuously working to enhance the user experience and provide additional features and services. Stay tuned for updates and exciting new offerings on the LAIR platform!

Thank you for choosing LAIR. We hope you have a delightful experience exploring our luxurious properties.


    ███        ▄█    █▄       ▄████████ ███▄▄▄▄      ▄█   ▄█▄      ▄██   ▄    ▄██████▄  ███    █▄
▀█████████▄   ███    ███     ███    ███ ███▀▀▀██▄   ███ ▄███▀      ███   ██▄ ███    ███ ███    ███
   ▀███▀▀██   ███    ███     ███    ███ ███   ███   ███▐██▀        ███▄▄▄███ ███    ███ ███    ███
    ███   ▀  ▄███▄▄▄▄███▄▄   ███    ███ ███   ███  ▄█████▀         ▀▀▀▀▀▀███ ███    ███ ███    ███
    ███     ▀▀███▀▀▀▀███▀  ▀███████████ ███   ███ ▀▀█████▄         ▄██   ███ ███    ███ ███    ███
    ███       ███    ███     ███    ███ ███   ███   ███▐██▄        ███   ███ ███    ███ ███    ███
    ███       ███    ███     ███    ███ ███   ███   ███ ▀███▄      ███   ███ ███    ███ ███    ███
   ▄████▀     ███    █▀      ███    █▀   ▀█   █▀    ███   ▀█▀       ▀█████▀   ▀██████▀  ████████▀
                                                    ▀