Freehold

You can find the deployed project at https://www.freehold.dev.

Contributors

LAMBDA WEBPT6

Tyler Turnipseed	Ian Bryant	Elvis Gonzalez	Tewodros Zenebe	Anthony Vigliotta

LAMBDA WEBPT8

Nick Durbin	Ian Carreras	Cole Gonzalez	Danny Town

Adam Penman	Vlad Burlutskiy	Clif Hodges

Code Climate Coverage

Project Overview

Trello Board

Product Canvas

UX Design files

PropMan is a property management application intended to become a one stop shop for all property management needs. A property manager can manage their properties, tenants and work orders all in one dashboard.

Key Features

• Create and Edit Properties
• Add Tenants to Properties
• Edit Tenants
• Create and Edit Work Orders

Tech Stack

Front end built using:

React w/ Redux

• Create React App
• Material UI
• Reach Router
• React Spring

Front end deployed to Netlify

Back end built using:

Node and Express

• Firebase Auth
• Jest
• PostgreSQL
• Knex

APIs

Firebase Auth

User management and Authentication is handled with the Firebase Authentication API implemented on the backend. This allows us to leverage the security of offloading the auth process to a more secure and robust service while still being able to manage data with our backend.

|

Testing

We are using React Testing Library / Jest for testing the front-end.

Installation Instructions

The dev environment is simple.

git clone

npm install

npm start

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.