sanja969 / house-rental-api

House Rental

This project an API for the reservation of houses. If you're planning a special day or event, or if you want to spend time with your family, this is the website for you.You can book a house in any city on the planet.  Main features of this website are:

• Users can see details of all the Houses.
• Users can reserve a house for a special day and in the specific city.
• Admin users can add and dlete houses.

Built With

• Technologies: Ruby on Rails, JWT, Rspec, Swager, PostgreSql

Link to front-end App

• Gitgub link click
• Heroku link click

Live Demo

Live Demo Link

• Kanban Board
• Kanban Board: Kanban Board link Initial state of the Kanban Board:

• Front-end iamge

Getting Started

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

Prerequisites

• A web browser like Google Chrome.
• A code editor like Visual Studio Code with Git and nodejs.
• Have visual-studio code or any other code editor installed on your computer.

Setup

• In order to get a copy of this project you need to download it from link
• Extract the zipped file and open it in your code editor

Install and start

• Run the command below in your terminal to get all required files:

bundle install

rails db:drop db:create db:migrate

rails s

Test

• Run tests with the next command:

• rake rswag

Authors

👤 Sanja Mandic

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Yohannes Dagnachew

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 NabilHY

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🤝 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

• Hats off to the whole microverse community
• Original design idea by Murat Korkmaz on Behance.

📝 License

This project is MIT licensed.

house-rental-api's Issues

[10 pt] Setup Rails API and POST and GET user API

Create rails API with Postgres setup. Create a user table, controller, and route for creating new users.
Also setup the Admin role and authorization

[ 1 pt] API with delete and post action for homes

Create and delete actions in the homes controller for creating a new home and deleting specific home

[4.5 pt] Detail page

When the user selects a specific item, they can see the details page with its full description.

Fetch JSON with hame detailed info from created API

In the details page, the user can click the "Reserve" button (in the design you can see the "Configure" button - please replace it with the "Reserve" button).
Details

When the user clicks the "Add item" link in the navigation panel they can see a form for adding a new item.

Make the app responsive, creating both mobile and desktop versions.

[4 pt] My reservations

When the user clicks the "My reservations" link in the navigation panel they can see a list of their reservations (with information about item name, date and city).

[3 pt] "Delete item" link

When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with title and "Delete" button.
When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore.

[3 pt] "Delete item" link

When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with title and "Delete" button.
When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore.

[4 pt] Reserve an appointment

To reserve an appointment, the user has to select a date and city (username and selected item are autofilled).
Use the design based on the "Book a vespa test-ride" and add all necessary inputs.
The user can also access the "Reserve" page from the navigation panel. In that case only username is autofilled.

[4 pt] Add full documentation for your API.

Add full documentation for your API.

Link to Kanban project

In this project are included three participant

Link to the project - https://github.com/users/Sanja969/projects/7
This project includes two repo for back end and front and separatly

[5.5 pt] Setup, organize app and Autothencitation pages

Make redux reducer, action, and store for posting user to created API. Create a User auth component for sign-in and sign-up and add it to react routes

[7 pt] Make reservations endpoint

Generate a reservation model with user_is and home_id, as well as the date, city, and status.

Create a reservations controller with index action for showing lists of reservations and create action for making new reservations.

[4 pt] Navigation panel

User can see links to:

Motorcycles/doctors/classes/items that you selected as a theme.
"Reserve" form.
"My reservations".
"Add motorcycle/doctor/class/item that you selected as a theme" (the link is visible to everybody).
"Delete motorcycle/doctor/class/item that you selected as a theme" (the link is visible to everybody).

[3 pt] "Add item" link

When the user clicks the "Add item" link in the navigation panel they can see a form for adding a new item.

[7pt] Main page

On the main page, the user can see a list of homes. Fetch a list of homes from created API.

Link to the front-end

Homes-rental-front-end

[3 pt] Endpoint for Homes

Generate home model and migrations for creating homes table in Postgres. Generate homes controller for returning JSON.

In the controller make index and show actions, for returning a list of homes and home details respectively in JSON.