# Backend:

{% embed url="https://files.slack.com/files-pri/TSZCHB482-F02D5G11ARK/image.png" %}

![](https://197560121-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkP23pBP3MWkIzJcreW%2Fuploads%2Fgit-blob-bf49c6a17523c3b850467a5b3f18defdf16825a5%2Fimage.png?alt=media)

{% embed url="https://github.com/Lambda-School-Labs/family-promise-service-tracker-be-a" %}

## Family Promise Service Tracker

[Family Promise](https://familypromise.org) 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.

### Schema

[DB Designer Schema Link](https://dbdesigner.page.link/VWjy5xWKghDumgmV8)

### Status

Deployed here: [https://fp-service-tracker.herokuapp.com/](https://fp-service-tracker.herokuapp.com)

_**Needs Updating**_ Current Roadmap in [Notion](https://www.notion.so/Roadmap-Family-Promise-Service-Tracker-2ca00c11c8e14dec93c861ac7aae49c0), all activity tracked in [Trello](https://trello.com/b/U8UUCBeb/family-promise-service-tracker).

### Requirements

Details on the Labs Node Scaffolding here: [https://docs.labs.lambdaschool.com/labs-api-strarter/](https://docs.labs.lambdaschool.com/labs-api-strarter/)

Labs teams must follow all [Labs Engineering Standards](https://docs.labs.lambdaschool.com/standards/).

### Documentation

* 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**

### Getting Started

Please reference the step by step instructions to setup development environment in **/docs/dev-setup.md**

#### Enviornment Variables

* `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/](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

#### Setup postgres

There are 3 options to get postgresql installed locally \[Choose one]:

1. Use docker. [Install](https://docs.docker.com/get-docker/) for your platform
   * run: `docker-compose up -d` to start up the postgresql database and pgadmin.
   * Open a browser to [pgadmin](http://localhost:5050) 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`
2. Download and install postgresql directly from the [main site](https://www.postgresql.org/download/)
   * 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).
3. Setup a free account at [ElephantSQL](https://www.elephantsql.com/plans.html)
   * _**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

#### Setup the application

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