Last updated
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.
Deployed here: https://fp-service-tracker.herokuapp.com/
Needs Updating Current Roadmap in Notion, all activity tracked in Trello.
Details on the Labs Node Scaffolding here: https://docs.labs.lambdaschool.com/labs-api-strarter/
Labs teams must follow all Labs Engineering Standards.
The documentation for how to work with the JSONB column used for Service Entry data and type models, check out /docs/API-README-SERVICE-ENTRIES.md
The current API documentation is found in /docs/API-README.md
List of known issues is found in /docs/known-defects.md
Pull Request Template found in /docs/pull_request_template.md
Please reference the step by step instructions to setup development environment in /docs/dev-setup.md
PORT - API port (optional, but helpful with FE running as well)
The following ports are whitelisted for use with okta
3000
8000
8080
DS_API_URL - URL to a data science api. (eg. https://ds-bw-test.herokuapp.com/)
DS_API_TOKEN - authorization header token for data science api (eg. SUPERSECRET)
DEV_DATABASE_URL - connection string for local postgres database
OKTA_URL_ISSUER - The complete issuer URL for verifying okta access tokens. https://example.okta.com/oauth2/default
OKTA_CLIENT_ID - the okta client ID.
OKTA_ORG_URL - The base url for the Okta org
OKTA_API_TOKEN - Okta API token
See .env.sample for example values
There are 3 options to get postgresql installed locally [Choose one]:
Use docker. Install for your platform
run: docker-compose up -d to start up the postgresql database and pgadmin.
Open a browser to pgadmin and you should see the Dev and Test server already defined.
If you need to start over you will need to delete the folder $ rm -rf ./data/pg as this is where all of the server data is stored (ONLY IF YOU NEED TO START OVER)
Upon logging into postgres admin on localhost (2nd dash above), you'll see the API-DEV server, but you will need to check if there is a "api-dev" database within that server, if not or if the databases api-dev and api-test were not created then you'll need to create them by right clicking databases, clicking create database, and adding a database for "api-dev" and then start over at step 1. You may need to grant system execution access to the .sh file in docker/pg/pg-init-scripts:
Run following from within root: chmod +x ./docker/pg/pg-init-scripts/create-multiple-postgresql-databases.sh
Download and install postgresql directly from the main site
make note of the port, username and password you use to setup the database.
Connect your client to the server manually using the values previously mentioned
You will need to create a database manually using a client.
Make sure to update the DATABASE_URL connection string with the values for username/password, databasename and server port (if not 5432).
Setup a free account at ElephantSQL
Downside: JSONB column displays as [object Object], so not good when testing/creating JSON queries
Sign up for a free Tiney Turtle plan
copy the URL to the DATABASE_URL .env variable
make sure to add ?ssl=true to the end of this url
create your project repo by forking or using this as a template.
run: npm install to download all dependencies.
run: cp .env.sample .env and update the enviornment variables to match your local setup.
run: npm run knex migrate:latest to create the starting schema.
run: npm run knex seed:run to populate your db with some data.
run: npm run tests to confirm all is setup and tests pass.
run: npm run watch:dev to start nodemon in local dev enviornment.
Readme:
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/.
\
DO NOT fork the repo. Clone directly!
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.
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
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
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"
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.
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.
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.
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.
See Backend Documentation for details on the backend of our project.
\
\
\
