theprivatepark/aroomi-backend

aRoomi

aRoomi is a project build with ruby on rails with a react frontend.

aRoomi is a platform for college students to find a roommate quickly that goes to their school.

This is the repo for aRoomi's backend

To view frontend please visit: https://github.com/theprivatepark/aRoomi-backend/blob/main/README.md

Features

A user can search through a list of colleges and find all of the listings there.

A user can click on a listing and view the listing details as well as see all of the pictures of the room/house.

A user can post a new listing.

Architecture and models

Models include:

• The User model
• College model
• Listing model
• Listing Pictures model

Relations:

• College has many Listings
• Listing belong to a College
• Listing has many Listing Pictures
• Listing has many Users
• User belongs to a Listing

Technologies

• Built on ruby '2.6.1'
• rails (~> 6.0.3, >= 6.0.3.4)
• uses a postgres database
• Authentication done with 'bcrypt' ruby gem
• react-bootstrap for styling

Setup

$ bundle install (to download gems)
$ rails db:create
$ rails db:migrate
$ rails db:seed
$ rails s (to start server)
$ npm start