Git Product home page Git Product logo

reem-lab / house-booking-back-end Goto Github PK

View Code? Open in Web Editor NEW
7.0 1.0 3.0 80 KB

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.

License: MIT License

Ruby 99.64% HTML 0.36%
api database devise-jwt postgresql postman-documentation rspec-rails ruby ruby-on-rails

house-booking-back-end's Introduction

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

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.

house-booking-back-end's People

Contributors

aimemalaika avatar german-cobian avatar piero-vic avatar reem-lab avatar sahar-abdelsamad avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

house-booking-back-end's Issues

[1.5pt] Add Models and set up association

  • Add a model for user
  • Add a model for reservation
  • Add a model for the houses.
  • A user can have many reservations and houses
  • A house can have many reservations
  • Add validations

[1pt] Fix Navbar

Make sure the Navbar works on every page on mobile and desktop version

[3pt]Delete item page

  • When the user clicks the "Delete item" link in the navigation
    the 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.

[4pt] Details page

  • When a user selects a specific item on the main page, they can
    see a page with details.
  • The user can click the "Reserve" button.

[3pt]My Reservations Page

  • 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).

[4pt] Main Page

In the main page, the user can see a list of houses with minor details about the houses.

[6pt ] Add item form

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

[4pt] Reservation form

  • When the user clicks the "Reserve" button they are
    redirected to a form to reserve a house.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.