Skip to content
forked from piper88/abba

Abba is a simple REST API helps homeowners or prospective owners predict potential AirBnB rental income for one or more spare bedrooms.

Notifications You must be signed in to change notification settings

Raziyehbazargan/abba

 
 

Repository files navigation

Coverage Status

Abba

Abba is a simple REST API helps homeowners or prospective owners predict potential AirBnB rental income for one or more spare bedrooms.

Description

Abba is a a RESTful API that uses full CRUD operations to allow clients to perform a http requests on a variety of routes. For more route information check out the wiki.

Why this should exist

With home prices constantly on the rise, home ownership is a huge financial burden on most first-time homeowners. Even for people making good wages, the prospect of adding huge monthly mortgage payments to the all-too-common student loan or consumer debt is daunting. However, the rise of short-term rental sites like AirBnB now allow for homeowners to rent out one or more spare bedrooms and use the income to lessen their debt burden. The problem is that, until now, the income potential for AirBnBing small bedrooms has been hard to quantify.

That's why we created this tool: using historical data we can predict the monthly rental income potential for homeowners or prospective buyers based on a given address and some basic facts about the property.

Instructions

  1. Fork & clone into a local repository
  2. Run 'npm install'
  3. Run 'npm start' to start the server (with nodemon and debug on by default)
  4. To test, 'npm test' - uses Mocha and Chai for testing, Istanbul and Coveralls.io for code coverage..

Team Members

Logan, Adam, Raziyeh, and Sarah.

This project was created as part of a Codefellows 401 Javascript course. Special thanks to our awesome instructors.

License: MIT.

About

Abba is a simple REST API helps homeowners or prospective owners predict potential AirBnB rental income for one or more spare bedrooms.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 71.8%
  • CSS 18.8%
  • HTML 9.4%