You can find the deployed project at Family Promise of Spokane.
The Family Promise of Spokane Organization is a US-based nonprofit organization based in Spokane, WA. They are an organization that helps homeless families as well as preventing families from becoming homeless. They provide shelter for families as well as rental assistance. For the full description visit their website Family Promise of Spokane
| Kristine Wang | Tyler Etheridge | Santiago Berniz | Leslie Rodriguez |
|---|---|---|---|
 |
 |
 |
 |
| TPL | Data Scientist | Data Scientist | Web Developer |
 |
|
|
|
| Emily Huntwork | Abdi Mo | Isaiah Fowler |
|---|---|---|
 |
 |
 |
| Web Developer | Web Developer | Web Developer |
| |
|
|
Front End Dashboard | Data Science API | Back End API |
Family Promise of Spokane Back End | Family Promise of Spokane Data Science | Family Promise of Spokane Front end
Each user should have one associated role determining which features are available to them. Flows should be designed to accommodate the addition of more user roles in the future.
Our product supported the following user roles:
- Executive Director
- Supervisor: Responsible for handling the day-to-day needs of the guests at the shelter, including conducting intakes of new families.
- Case Manager: Writes case notes on guests the shelter is serving as they work with them.
- Guest : A "head of household" arriving to or checked into the shelter as part of a family unit of some kind.
and the following user stories:
- All users should be able to view and update a user profile.
- Guests should be able to check in to the shelter using a form. This form should be as simple and user-friendly as possible. We need to distinguish new guests from returning guests and log the check-in accordingly.
- New guests should have a profile created for them.
- Supervisors should be able to view all guests currently checked into the shelter.
- Case Managers should be able to look up guests and log notes associated with ongoing case management.
- Case Managers should be able to view and edit and Guests should be able to view those notes. Entries should be confidential between the case manager and the guest.
- Supervisors can Create guest profile
- Case Manager can view guest profile
- Case Manager can view the exit destination prediction
- Guest can be flagged for mis conduct
- notes can be added to guest's profile.
- Guest can view their own profile.
- Styling/Design : ANT Design
- State Management : Redux
- React Modals
- PostgreSQL
- Testing: React Testing Library
- Database : PostgreSQL
- Auth: Okta JSON Web Token Verifiyer
- Testing: Jest SuperTest
- Migrations/Seeding: Knex
- Express
- CORS
- Helmet
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.
Please reach out to Abdi, Isaiah, Leslie or Emily for any support or questions.
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.
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.
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.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.