Skip to content

Booking_Home Backend is a RESTful API that allows users to rent or buy a home.

Notifications You must be signed in to change notification settings

Mosams/booking-home-API

Repository files navigation

Booking_Home Backend

Booking_Home Backend is a RESTful API that allows users to rent or buy a home.

API Manipulation and Endpoints

If you need further information about the endpoints you can view the documentation navigating to /api-docs. If you would like to clone and view it on your side then try http://localhost:3000/api-docs.

ERD

Built With

  • Ruby
  • Ruby on Rails
  • PostgreSQL

Front end Repository

Pull Request Kanban Board

Getting Started

  • Install Ruby on your local machine

  • Install Ruby on Rails

  • Clone this repository

    git clone git@github.com:Mosams/booking-home-API.git
    
  • To get started, In the root directory run:

    gem install bundler
    

    Then run:

    bundle install
    

    To start the server run:

    rails s
    

    Open the browser with localhost:3000

After installing bundle

Please run the following commands rails db:create rails db:migrate rails s

Tests

bundle exec rspec

Or

rspec spec

To track linter errors locally follow these steps:

Track linter errors run:

rubocop

Authors

👩 Meri Gogichashvili

👨 Sam Mong'are

👨 Yassine Omari

👨 Mohamed ElShamy

🤝 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

  • Thanks to our reviewers and coding partners.

📝 License

This project is MIT licensed.

About

Booking_Home Backend is a RESTful API that allows users to rent or buy a home.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published