Community Connect is a mobile app that gives Colorado users a central place to access the resources that they need to better their lives. Resources range from immediate help hotlines, nonprofits that offer various services, and a map of alchohol/drug recovery meetings in Colorado.
The back-end part of the application houses the nonprofit resources and recovery meetings information and makes that information available via GraphQL requests.
- Introduction
- Initial Setup
- How to Run Tests
- Endpoint
- Schema Design
- Tech Stack List
- Core Contributors
Follow the following steps to setup application locally. Setup time is 5-10 minutes.
The easiest way to get started is to run the following command. This will pull down any necessary dependencies that your app will require.
npm install
You’ll need to figure out a name for your database. We suggest calling it something like community_connect_dev.
You will also need to update the development section of the knexfile with the database name.
Instructions to create the database and run migrations:
psql
CREATE DATABASE DATABASE_NAME_dev;
\q
knex migrate:latest
You will need to import resources and recovery meeting information into the database. Xlsx files with the necessary data are already provided in the repo. In order to import that data into your database, run the following commands:
node import.js
node import_recovery.js
Most of the setup is going to be same as the one you did before. You’ll notice one small difference with setting the environment flag to test.
psql
CREATE DATABASE DATABASE_NAME_test;
\q
knex migrate:latest --env test
You will also need to update the test section of the knexfile with the test database name.
Running tests are simple and require you to run the following command below:
npm test
Production address with a single endpoint:
https://stormy-depths-45174.herokuapp.com/resources
To access locally:
npm start
http://localhost:4000/resources
Returns all resources from the database. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all resources in JSON format.
Sample Request Query:
{
resources{
name
id
website
street
city
state
zip_code
contact
notes
category
subcategory
favorited
}
}
Sample Successful Response:
{
"data": {
"resources": [
{
"name": "Wee Cycle",
"id": "1",
"website": "http://www.weecycle.org/",
"street": "789 Sherman Street #250",
"city": "Denver",
"state": "CO",
"zip_code": "80203",
"contact": "720-319-7792",
"notes": "Provides new or gently used baby gear for low-income families with infants and toddlers.",
"category": "Baby Items",
"subcategory": "",
"favorited": null
},
{
"name": "Clayton Family Futures",
"id": "2",
"website": "http://www.claytonearlylearning.org/",
"street": "3801 Martin Luther King Blvd.",
"city": "Denver",
"state": "CO",
"zip_code": "80205",
"contact": "(303) 355-4411",
"notes": "Prenatal intervention & child development services",
"category": "Child Care",
"subcategory": "Preschools",
"favorited": null
}
]
}
}
Returns all resources from the database that have a specified category. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resources_by_category(category: "Baby Items") {
name
website
street
city
state
}
}
Sample Successful Response:
{
"data": {
"resources_by_category": [
{
"name": "Wee Cycle",
"website": "http://www.weecycle.org/",
"street": "789 Sherman Street #250",
"city": "Denver",
"state": "CO"
}
]
}
}
Returns the resource from the database that have a specified id. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for the resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resource(id: 30) {
name
website
street
city
state
}
}
Sample Successful Response:
{
"data": {
"resource": {
"name": "Volunteers of America Mission",
"website": "http://www.voacolorado.org/gethelp-denvermetro-\n foodnutrition-themission",
"street": "2877 Lawrence Street Denver",
"city": "Denver",
"state": "CO"
}
}
}
Returns all resources from the database that have a specified city. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resources_by_city(city: "Commerce City") {
name
website
street
city
state
}
}
Sample Successful Response:
{
"data": {
"resources_by_city": [
{
"name": "Dr. Lawrence Willis (Commerce City Dental Center)",
"website": "n/a",
"street": "6537 E. 72nd Place",
"city": "Commerce City",
"state": "CO"
}
]
}
}
Returns all resources from the database that have a specified zip code. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resources_by_zip_code(zip_code: "80226") {
name
website
street
city
state
}
}
Sample Successful Response:
{
"data": {
"resources_by_zip_code": [
{
"name": "Rocky Mountain SER - Head Start Program",
"website": "http://www.rmser.org/rmser-programs/headstart-program",
"street": "150 Sheridan Blvd",
"city": "Denver",
"state": "CO"
}
]
}
}
Returns all resources from the database that have notes that contain something specified by the user. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resources_by_notes(notes: "boxes") {
name
website
street
notes
}
}
Sample Successful Response:
{
"data": {
"resources_by_notes": [
{
"name": "Denver Rescue Mission: Ministry Outreach Center",
"website": "https://www.denverrescuemission.org/emergency-services",
"street": "5725 East 39th Avenue",
"notes": "Food boxes available once a month: Tues.-Sat. 8:30-11am & 11:30am-4 pm"
},
{
"name": "Denver Rescue Mission: Harvest Farms",
"website": "https://www.denverrescuemission.org/emergency-services",
"street": "4240 E. County Road 66",
"notes": "Food boxes available once a month: Mon.-Fri. 9:45 am-11:45 am & 1pm-3:45 pm, Saturday 8am - 12pm"
}
]
}
}
Returns all resources from the database that have a specified subcategory. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resources_by_subcategory(subcategory: "After School Programs") {
name
website
street
city
state
}
}
Sample Successful Response:
{
"data": {
"resources_by_subcategory": [
{
"name": "YMCA Child Care Center",
"website": "http://www.denverymca.org/child-care-camps",
"street": "2625 S Colorado Blvd",
"city": "Denver",
"state": "CO"
},
{
"name": "Sun Valley Youth Center",
"website": "http://www.sunvalleyyouthcenter.org/programs",
"street": "1230 Decatur St",
"city": "Denver",
"state": "CO"
}
]
}
}
Returns all resources from the database that have a specified favorited status. The attributes id, name, website, street, city, state, zip code, contact, notes, category, subcategory, and favorited can also be requested for each resource.
If successful, response will contain all relevant resources in JSON format.
Sample Request Query:
{
resources_by_favorited(favorited: null) {
name
favorited
}
}
Sample Successful Response:
{
"data": {
"resources_by_favorited": [
{
"name": "Wee Cycle",
"favorited": null
}
]
}
}
Returns all recovery groups from the database. The attributes title, subtitle, and address can also be requested for each recovery group.
GET /api/v1/resources
If successful, response will contain all recovery groups in JSON format.
Sample Request Query:
{
recovery{
title
subtitle
address
}
}
Sample Successful Response:
{
"data": {
"recovery": [
{
"title": "AA: P.P. Workshop Mon - Sat 6:45 AM",
"subtitle": "Too Young To Die Mon & Wed 8 PM",
"address": "8545 E Dry Creek Rd"
},
{
"title": "AA: Grateful 2b here",
"subtitle": "Thursday7:30 pm",
"address": "8700 E 21st Ave"
}
]
}
}
