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
• Link to the final state of our Kanban board
• Our team consist of 4 members

API Full Documentation

• Much more populated documentation for this API was made with Postman and can be found here. 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

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
Twitter	Rem79940127
LinkdIn	reem-janina

👤 Sahar Abdel Samad

Platform	Badge
GitHub	Sahar-AbdelSamad
Twitter	@AbdelSamadSaha
LinkdIn	Sahar-Abdel-Samad

👤 Piero Lescano

Platform	Badge
GitHub	@piero-vic
Twitter	@v1ccenzo
LinkdIn	piero-lescano

👤 Aime Malaika

Platform	Badge
GitHub	@aimemalaika
Twitter	@Aime_Malaika
LinkdIn	aimemalaika

🤝 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

• Microverse

📝 License

This project is MIT licensed.