Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reem-lab/house-booking-back-end
This is a Ruby on Rails API part of a full-stack project called "Rent me". This project is based on an app to book an appointment to rent a house. You can see different types of houses and you can see the details for each house then you can reserve an appointment to the specific house that you also choose you can see all your reservations on a separate page. The user also can add and delete a house.
https://github.com/reem-lab/house-booking-back-end
api database devise-jwt postgresql postman-documentation rspec-rails ruby ruby-on-rails
Last synced: 18 days ago
JSON representation
This is a Ruby on Rails API part of a full-stack project called "Rent me". This project is based on an app to book an appointment to rent a house. You can see different types of houses and you can see the details for each house then you can reserve an appointment to the specific house that you also choose you can see all your reservations on a separate page. The user also can add and delete a house.
- Host: GitHub
- URL: https://github.com/reem-lab/house-booking-back-end
- Owner: Reem-lab
- License: mit
- Created: 2022-06-01T20:33:21.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-08-12T17:00:01.000Z (about 2 years ago)
- Last Synced: 2024-10-04T05:04:27.356Z (about 1 month ago)
- Topics: api, database, devise-jwt, postgresql, postman-documentation, rspec-rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 78.1 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rent Me
> This is a Ruby on Rails API part of a full-stack project called "Rent me". This project is based on an app to book an appointment to rent a house. You can see different types of houses and you can see the details for each house then you can reserve an appointment to the specific house that you also choose you can see all your reservations on a separate page. The user also can add and delete a house.🏠🏡
## Kanban board
- [Link to the initial state of our Kanban board](https://user-images.githubusercontent.com/87965534/171515644-043c6210-3210-40ff-ad71-9a1ca5c5dbdb.png)
- [Link to the final state of our Kanban board](https://github.com/Reem-lab/house-booking-back-end/projects/1)
- [Our team consist of 4 members](#authors)
## API Full Documentation
- Much more populated documentation for this API was made with Postman and [can be found here](https://documenter.getpostman.com/view/17756817/UzBgup9u). It includes all the available methods, required headers and parameters, and examples for different responses. The application is deployed if you want to try it replace `localhost:3001` with `https://aqueous-temple-36685.herokuapp.com`.
## Front-end Repository
[ReactApp](https://github.com/piero-vic/house-booking-front-end)
## Built With
- Ruby
- Ruby on Rails
- PostgreSQL
- Devise JWT
## Tools and extensions
- Thunder Client
- Postman for documentation.
## Technologies used
- Visual Studio Code
## Configuration
To use this project you first need to have installed the following:
+ Node.js
+ Ruby
+ PostgreSQL
+ Rails
* Ruby version
The version of ruby that is needed for this project is
+ 3.1.1
Once you have installed them, you need to use the following command to clone the repository:
```
git clone https://github.com/Reem-lab/house-booking-back-end.git
```
## After you Clone
Commands to run:
```
bundle install
```
### Database creation
Next, use this command to create the databases:
```
rails db:create
```
And you have to migrate the DB:
```
rails db:migrate
```
## Usage
Finally, use the following command to initialize the live server:
```
rails s
```
```
The server will be running on "localhost:3001"
```
## How to run the tests
```
rspec spec
```
### or :
```
rspec spec/models
rspec spec/requests
```
## Authors
👤 **Reem Janina**
Platform | Badge |
--- | --- |
**GitHub** | [@Reem-lab](https://github.com/Reem-lab)
**Twitter** | [Rem79940127](https://twitter.com/Rem79940127)
**LinkdIn** | [reem-janina](https://www.linkedin.com/in/reem-janina-ab74ab21a/)
👤 **Sahar Abdel Samad**
Platform | Badge |
--- | --- |
**GitHub** | [Sahar-AbdelSamad](https://github.com/Sahar-AbdelSamad)
**Twitter** | [@AbdelSamadSaha](https://twitter.com/AbdelSamadSahar)
**LinkdIn** | [Sahar-Abdel-Samad](https://www.linkedin.com/in/sahar-abdel-samad/)
👤 **Piero Lescano**
Platform | Badge |
--- | --- |
**GitHub** | [@piero-vic](https://github.com/piero-vic)
**Twitter** | [@v1ccenzo](https://twitter.com/v1ccenzo)
**LinkdIn** | [piero-lescano](https://www.linkedin.com/in/piero-lescano/)
👤 **Aime Malaika**
Platform | Badge |
--- | --- |
**GitHub** | [@aimemalaika](https://github.com/aimemalaika)
**Twitter** | [@Aime_Malaika](https://twitter.com/Aime_Malaika)
**LinkdIn** | [aimemalaika](https://www.linkedin.com/in/aimemalaika/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Microverse
## 📝 License
This project is [MIT](./LICENSE) licensed.