# Miami-Dade Vacancy Compliance Portal

Miami-Dade Vacancy Compliance Portal is an internal web application for Miami-Dade county employees to keep track of all the public housing in the County.
This application provides a discrepancy tool to view housing units in Miami-Dade County database and Federal Government database with conflicting statuses across the County.
This tool helps reduce unwarranted personnel deployments as well as bring down overall man hours to keep track of all the discrepancies.

## Installation

To install the project, please refer to the installation guide.

## Usage
Code Structure:
1. The directory folder (mph-api-django) is the directory containing both front-end and back-end subsystems.
2. The front-end subsystem is contained in the MDC-Public-Housing directory.
3. The back-end subsystem is contained in the following subdirectories:
  a. api
  b. import_scripts
  c. mph
  d. users
4. The front-end subsystem is contained in the following subdirectory:
  a. src

To start the back-end from the root directory, run the following commands that can also be found in the installation guide (Mac/Linux):
```bash
$ source venv/bin/activate
$ python manage.py runserver
```

To start the front-end from the MDC-Public-Housing directory, run the following commands that can also be found in the installation guide:
```bash
$ npm start
```

## Contributing
For those who are inheriting the project, please visit the shortcomings/wishlist document or take a look at [this.] (https://www.youtube.com/watch?v=0JcEoXjBfRg)

## License
All libraries used are open source with an MIT license.
[MIT](https://choosealicense.com/licenses/mit/)
