Skip to content

my-lambda-projects/family-promise-service-tracker-fe-a

 
 

Repository files navigation

Basic SPA

For steps on how to work with this repository please see here

Family Promise Service Tracker

Family Promise helps local communities coordinate their compassion to address the root causes of family homelessness. They tap existing local resources to empower families towards economic stability. Families come to them in crisis; they help them rebuild their lives with new skills and ongoing support. They address the issue holistically, providing prevention services before families reach crisis, shelter and case management when they become homeless, and stabilization programs once they have secured housing to ensure they remain independent.

Family Promise needs a way to track and visualize the services they provide external to the shelter to gain actionable insights.

Our goal is to build a generalizable monitoring and evaluation (M&E) platform that meets Family Promise's needs, with an eye toward additional potential use cases that would be useful for many other organizations.

You can find the deployed project at a.familypromiseservicetracker.dev/.



https://mit-license.org https://reactjs.org code style: prettier

  • Fork and clone the repo to install it as your own remote.
  • run: npm install to download all dependencies.
  • run: npm start to start your local development server.

When using Okta for authentication, the app will need to run locally on port 3000.

Key Features

  • Admin users can add / edit / delete employees, add / edit / delete programs, add / edit / delete services types & add / edit / delete services.
  • Program Managers can add / edit / delete programs, add / edit / delete services types & add / edit / delete services.
  • Service Managers can view and add / edit / delete services.
  • All users can update their profile image and names.

Front end deployed to AWS Amplify.

Back end built using:

Node.js with Postgres

  • point one
  • point two
  • point three

Installation Instructions

create your project repo by forking or using this as a template. run: npm install to download all dependencies. run: npm start to start the live server. Note: must be running on localhost:3000 g

Map setup

Setting up map for dashboard:

Must have a token setup in a .env.local file (must create file on fresh clone) with the following format for map to render REACT_APP_MAPBOX_TOKEN = "Token string"

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

  • 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.

Documentation

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

Contributors

Front-End Team (Labs 35)

Adam Purdy Jason Corchado Jonathan Calderon
Monica Zwissler Robert Allen

Back-End Team (Labs 35)

Adam Selter Domenic Scarcella Jay Ponce de Leon Matthew Ellis
Monica Zwissler Nick Samples Weston Woodard

Front-End Team (Labs 33)

Hussain Ali Ruben Ramirez Bryan Diaz Jose Robles

Back-End Team (Labs 33)

Chris Sutton Brandon O'Neal

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.0%
  • SCSS 2.3%
  • Other 0.7%