Skip to content

Latest commit

 

History

History
181 lines (110 loc) · 9.43 KB

README.md

File metadata and controls

181 lines (110 loc) · 9.43 KB
Raw

Family Promise of Spokane

Welcome to the Data Science Team B's repository for the Family Promise of Spokane Project! This repository holds all the source code for our API as well as the predictive model used by the app. At this time, there have been three iterations of this project with three different teams, each building upon the last.

Description

The Family Promise of Spokane is a US-based nonprofit organization based in Spokane, WA. They are an organization that aims to curb homelessness for families through both corrective and preventive measures. Their services include providing shelter for families as well as rental assitance. For more details of the organizations and the amazing work they do, be sure to check out their website.

User Flow

The aim of the project is to eventually have a central app for all user types of Family Promise.

Trello Board (Iteration 1)
Trello Board (Iteration 3)

Curent key features:

Guests:

  • Can log in and reserve services
  • Can view their profiles and reservations

Case managers:

  • Can log in and create guest profiles
  • Can view guest profile
  • Can add notes to a guest's profile and flag a guest for misconduct

Supervisors:

  • Same accessibility as case managers
  • Can predict a guest's exit type

Executive director:

  • Same accessibility as supervisors
  • Can view the shelter's KPIs

Contributors

Data Science Team

Kristine Wang Tyler Etheridge Santiago Berniz Christopher Lee
TPL Data Scientist Data Scientist Data Scientist
Ik Okoro Justin Rivest
Data Scientist Data Scientist

Future Teams

Any future DS team assigned to the project for Labs32, ensure you view 31's guide doc.



Deployments

As long as the sites are still hosted, you can find the deployments for each of the three branches of the full product below. Otherwise, to view source code or deploy locally, please see the linked repositories instead in the next section.

Front End Dashboard | Data Science API | Back End API

Linked Repositories

Family Promise of Spokane Front end | Family Promise of Spokane Back End

Architecture Chart

Architecture

Getting Started

Libraries

fastapi uvicorn

sqlalchemy python-dotenv

pandas scikit-learn plotly

Setup Instructions

In your CLI, clone the repository to your local machine using:

git clone <repository link>

In order for the app to function correctly, the user must set up valid environment variables. There should be a .env file in the root project directory containing the following:

SQLALCHEMY_DATABASE_URL = Postgres database credentials

To run the FastAPI app from your CLI, use:

uvicorn app.main:app --reload

You should be able to see the app running in your localhost after application startup is complete.

Tech Stack

Deployed API built with:

  • Python
  • FastAPI
  • Docker
  • AWS Elastic Beanstalk
  • PostgreSQL

Reasons for tech stack choices:

  • Gain insight into AWS deployments and debugging with Docker
  • Speed of FastAPI and its increase in popularity
  • Solid structure with SQL queries

Issues

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.

Support

Santiago and Tyler on slack.

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.

Describe what you have changed in this repo as a team Provide examples and descriptions of components, how props are handled, where to find these changes, database tables, models, etc.

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.