https://github.com/heblopez/get-that-home-api

API developed in Rails for the Get-That-Home project. Deployed in the Render service.
https://github.com/heblopez/get-that-home-api

Last synced: 3 days ago
JSON representation

API developed in Rails for the Get-That-Home project. Deployed in the Render service.

• Host: GitHub
• URL: https://github.com/heblopez/get-that-home-api
• Owner: heblopez
• License: other
• Created: 2023-04-07T16:21:21.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-17T19:58:07.000Z (6 months ago)
• Last Synced: 2024-12-11T19:14:53.240Z (about 2 months ago)
• Language: Ruby
• Homepage: https://get-that-home-api-zdhe.onrender.com/
• Size: 206 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Get that Home API

- API developed in Ruby on Rails 7.1.0.

- Ruby version: 3.1.2

![Landing page - Get that home](https://cdn.discordapp.com/attachments/1072664951749099633/1094309150437154977/image.png)

## Endpoints

### Sessions

- `POST /login`: Logs in with the user's credentials.

- `GET /logout`: Logs out the user.

### Users

- `POST /users`: Creates a new user.

- `GET /users/:id`: Returns the information of a specific user.

- `PATCH /users/:id`: Updates the information of a specific user.

### Properties

- `GET /properties`: Returns a list of all properties.

- `POST /properties`: Creates a new property.

- `GET /properties/:id`: Returns the information of a specific property.

- `PATCH /properties/:id`: Updates the information of a specific property.

- `DELETE /properties/:id`: Deletes a specific property.

### Favorites

- `GET /users/:id/favorites`: Returns a list of the properties marked as favorites by a specific user.

- `POST /users/:user_id/favorites/:property_id`: Create a new favorite property record for a specific user. 

- `DELETE /users/:user_id/favorites/:property_id`: Remove the favorite property record for a specific user.

### Contacted

- `GET /users/:id/contacted`: Returns a list of properties contacted by a specific user.

- `POST /users/:user_id/contacted/:property_id`: Create a new contacted property record for a specific user. 

- `DELETE /users/:user_id/contacted/:property_id`: Remove the contacted property record for a specific user.

## Authors

- [Cristoper Yarleque](https://github.com/CristoperYarleque)

- [Heberth Lopez](https://github.com/heblopez)

## License

- This work is licensed under a [Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License](https://creativecommons.org/licenses/by-nc-nd/3.0/). See the [LICENSE.md](https://github.com/heblopez/get-that-home-api/blob/main/LICENSE.md) file for details.