GedeonTS / yatch_house

An application to book houses for rent like Airbnb. The particularity is that the guests will live with their host to discover the local culture and customs. The user will be able to choose a house according to his preferences and book a period during which he will live with his guest.

Yatch House API

An application to book houses for rent like airbnb. The particularity is that the guests will live with their host to discover the local culture and customs. The user will be able to choose a house according to his preferences and book a period during which he will live with his guest.

Built With

• Ruby 3.1.2
• Ruby on rails 7.0.3
• postgresql (last version)
• Rspec (last version)
• Rubocop (last version)
• Devise (last version)
• cloudinary (last version)

Kanban Board

• Link to the Kanban Board
• 
• Number of team members in the project are 5, and they include;
  • @Yazino12
  • @rolandfbk
  • @kwambiee
  • @Baroka-wp
  • @GedeonTS

Getting Started

To get a local copy up and running follow these simple example steps.

    - git clone `[e-mail]:Baroka-wp/yatch_house.git`
    - cd yatch_house
    - bundle install
    - rails db:create
    - rails db:migrate
    - rails db:seed
    - rails s

Prerequisites

• Install :-
  • A text editor(preferably Visual Studio Code)
  • Git
  • Ruby 3.1.2
  • Ruby on rails 7.0.3
  • postgresql (last version)
  • Rspec (last version)

Usage

• Clone the repository to your local machine
• Run bundle install to install the necessary gems
• Run rails db:create to create the database
• Run rails db:migrate to migrate the database
• Run rails db:seed to seed the database
• Run rails s to start the server
• Open http://localhost:3001/ in your browser

Run tests

• Install Rspec with rails generate rspec:install
• Run rspec spec to run the tests

Check API Endpoints

• Run your rails server rails s and go to the URL and add /api-docs and behold the Swagger UI documentation of all endpoints for the controllers.

Front end github repo link

front-end repo

List of functions

• Login/ registration
• Check if user is admin
• Add and delete house
• Add reservation
• List of user reservations
• List of all house
• Check house is availableor not

Diagram UML

API endpoints

Authors

👤 Author : GEDEON USHINDI

• GitHub: @GedeonTS
• Twitter: @Gedeon191
• LinkedIn: Ushindi Gedeon

👤 Author : YASIN WARSAME

• GitHub: @Yazino12
• Twitter: @yasino24
• LinkedIn: yasin-warsame

👤 Author : IROTORI BAROKA

• LinkedIn:

• GitHub:

• Twitter:

• Gmail:

👤 Joy Kwamboka

• LinkedIn:

• GitHub:

• Twitter:

👤 Roland Ossisa Yuma

• GitHub: @rolandfbk
• LinkedIn: Roland Ossisa Yuma
• Twitter: @rolandfbk

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Inspiration: Microverse
• The Creative Commons license of the design

📝 License

This project is MIT licensed.