8000
Skip to content

gonznic/apartment-manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Apartment Manager

A scalable apartment management system.

AboutOverviewInstallationConfigurationUpdatesLicense

About

Apartment Manager is a scalable apartment management system with a focus on accessibility and transparency. It is responsible for leasing, rent collection, maintenance, and performance analytics. It is also designed in a minimalist and modern style, has dark/light mode, and can be rezised to a variety of sizes for compatibility.

Understanding a property’s performance should be simple and straight forward. Apartment Manager makes it easy for property managers to view and understand key performance indicators (KPIs) and periodic changes in operations. With an administrator account, a manager has full control over unit assignments, resident accounts, leases, and profitability.

This application also enhances customer experience. Residents can view their payment history, upcoming charges, lease information, and account status all in one place. It is also easy to make payments and understand a breakdown of an account’s charges.

Overview

Administrator Account

   Pages: Dashboard, Unit Manager, Resident Manager, Complaints, and Settings

Screenshots

 

Resident Account

   Pages: Dashboard, Complaints, and Settings

Screenshots

Installation

Requirements
  • Java SE
  • A SQL database and tool (Made using MariaDB and phpMyAdmin)
  • JDBC Connector for your type of SQL database (Made using MySQL Connector/J)
  • An IDE (Recommended) (Made using Eclipse)
Setup
  • Download and unzip the latest version of Apartment Manager.
  • Create a new SQL database (example query: CREATE DATABASE apartment_manager).
  • Import src/db/init.sql into the new databse to create the necessary tables.
  • Add the JDBC Connector to your project and set the classpath (In Eclipse: right click > “Build Path” > “Add to Build Path”). The JDBC Connector used during development can be found in lib/.
Database Access
  • Set the dbUrl, dbUsername, and dbPassword variables in src/main/java/Page.java to your SQL server url, and the log-in credentials to a database access account. This accout will be used by non-admin users to access the database: they should have privileges to SELECT from all tables and INSERT and UPDATE in payments and complaints.
  • Create a database account with the username and password: "admin", "password" (This is the default admin account in the users table). Administrator accounts must be created in the users table and have a database access account with the same username and password (Admin accounts use the same username and password used to log in to access the database). These accounts can hava all database privileges.
Run the Application
  • Compile and run src/main/java/Launch.java.
  • Log in using username and password: "admin", "password".
  • To access resident accounts, find a username in the admin's Resident Manager and log in with the password: "password".

Configuration

To generate demo data and fill the database:

  • Set the dbUrl, dbUsername, and dbPassword variables in src/db/PseudoDataGenerator.java to your SQL server url, and the log-in credentials to a database access account with all priviledges.
  • Compile and run PseudoDataGenerator.java. This will clear all data previously in the database except rows in the users table where type = 'admin' before inserting new data.

Updates

Apartment Manager has all the basic features required to manage residential multi-family properties. However, there are still features left to implement. Some include:

  • Inspections
  • Utility Payments
  • Security Deposits
  • Screening Tenants

This tool can also be expanded into a broader Property Management System (PMS), allowing an operator to manage different types of properties (commercial, hotel, industrial, etc.).

License

Apache License 2.0

About

A scalable apartment management system with a focus on accessibility.

Topics

Resources

License

Stars

1 star 498F

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

0