Git Product home page Git Product logo

rent-bills's Introduction

Rent Bills

Codacy Badge Coverage Status

Program

The working website can be found in the Rent Bills website http://rent-bills.herokuapp.com/ May take a while to load due to sleeping dynos. Sample user: [email protected] Password: 123

Description of program

Rent Bills is a web application to help homeowners monitor rent payments made by tenants.

Homeowners can create a location to represent houses/apartment/condominiums they own. A location could have several units. They can assign a tenant to each unit, based on a contract. A contract lasts for a time period and indicates the monthly rent that tenants need to pay. Homeowners will be able to see the accumulated rent owed/paid by a tenant.

Homeowners can employ keepers to collect payments made by tenants. Keepers will then input how much money they collected when onto the database. Keepers gain access information to a location by sending requests to owners.

How to run

Install Postgres into machine, then run: bundle install bundle pristine pg rails db:create rails db:migrate rails s

Ruby version

2.7.3

Schema

The following schema is used by the program.

ERD

Demo Screenshots

  1. Main Dashboard

  1. Tenant information

  1. Location information

  1. Contract Creator

  1. Due Scheduler

Features

User Management

  1. Users can sign up, log in and log out based on unique emails.
  2. Two types of users are supported: owners and keepers.

Locations and Units

  1. Owners and keepers are able to create locations.
  2. Keepers can sign themselves up as keepers for a house by sending requests to owners.
  3. Owners can accept or reject keepers' request to tend a house.
  4. Once keepers have access, they can view the location.

Tenants

  1. Owners can add tenants to locations.
  2. Owners can create a contract based on how long the tenant stays in a unit and how much the monthly rent is.

Keepers

  1. Keepers are able to see an overview of tenants and occupied units in the house.
  2. They can see contracts of tenants.

Navigation

  1. Owners and keepers have an overivew of locations they manage.
  2. Owners have shortcuts to locations they own in the nav bar.

Profile Users are able to view their own profile through link at navigation bar above.

Non-functional features

  1. SQL queries mostly optimised.
  2. Authorisation (only owners and keepers are able to view location information)

Future Development

  1. Further optimisation of SQL queries.
  2. RSpec tests to be written.

rent-bills's People

Contributors

codacy-badger avatar sciffany avatar

Stargazers

 avatar

Watchers

 avatar

rent-bills's Issues

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.