This is a Ruby on Rails API from which the React frontend serves the data. It is a simple Rails app that has three models - User, Listing and Favourite. For the authentication of the users I used JSON Web Tokens. Inspiration from this article series. The API is hosted on Heroku, at this endpoint: FindHouse - API - But they can only be accessed with a valid API token

• Major languages - Ruby
• frameworks - Ruby On Rails
• Linters - Rubocop
• Database - PostgreSQL

Live Demo Link

To get a local copy up and running follow these simple steps.

• nodejs must be installed on device

• Follow this steps according to get you running

1. clone the repo

git clone [email protected]:abruzy/find_your_house-backend.git

2. change directory

cd find_your_house-backend

3. install dependencies

bundle install

yarn

4. start the project

rails s -p 3001

There are several endpoint in this API and we'll be discussing the functionalities of each endpoint

• POST - for user sign in

  /auth/login

• POST - for user sign up

  /signup

• GET - for fetching the listings

  /listings

• GET - for fetching one particular listing

  /listings/:id

• GET - for fetching favourites for the current user
• POST - for adding a favourite to the current users favourites list
• DELETE - for removing a favourite from the current users favourites list

  /favourites

👤 Abubakar Diallo

• Twitter: @abruzy01
• Github: @abruzy
• LinkedIn: @abubakardiallo

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Give a ⭐️ if you like this project!

• Microverse

This project is MIT licensed.