gnl-graphql

graphql server for detroitledger.org

Built using:

• https://github.com/prisma/graphql-yoga
• https://github.com/mickhansen/graphql-sequelize
• https://github.com/mickhansen/dataloader-sequelize

Install

yarn install

Config

We use the config package to manage our configurations. See config/default.toml.

Set up databases

Create a postgres db that matches the info in config/default.toml or alternatively set up your own configuration overrides in config/local.toml.

Use the latest seed db from here

zcat snake_cased.sql.gz | psql gnl

or on OS X, gzcat snake_cased.sql.gz | psql gnl

Create a GNL user:

CREATE USER gnl;
GRANT CONNECT ON DATABASE gnl TO gnl;
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO gnl;

Running imports (if you have to)

yarn tsc && node dist/scripts/tagImporter.js

Add some admin users

For some reason, yarn sequelize db:seed <name-of-specific-seed> doesn't work - we can just invoke the seed manually.

yarn tsc && node scripts/add-users.js

Seed data & integration tests

Seed data generators are available at src/db/seeders. Currently the test-data seeder generates a hundred tags for each tag type, a thousand organizations, ten thousand grants, and six thousand rows of IRS data.

Modify config/test.toml as needed, and then:

yarn tsc
NODE_ENV=test yarn sequelize db:drop
NODE_ENV=test yarn sequelize db:create
NODE_ENV=test yarn sequelize db:migrate
NODE_ENV=test yarn sequelize db:seed:all

Use

yarn tsc && PORT=3000 node dist/index.js

Got to http://localhost:3000 for a playground

Sample query:

{
	query {
		organization(uuid: "03d9d71f-add5-4fe7-8701-67331a4dc795") {
			name
			uuid
			grantsFunded {
				uuid
				dateTo
				dateFrom
				to {
					name
					uuid
				}
				amount
				description
			}
			forms990 {
				start_year
				end_year
				irs_year
				total_assets
				total_revenue
				total_expenses
				total_liabilities
			}
		}
	}
}

Another sample query:

query {
  organizationMetas(
    organizationNameILike: "%foundation%"
    orderByMulti: [["totalFunded", "DESC NULLS LAST"]]
  ) {
    totalFunded
    totalReceived
    organization {
      name
    }
  }
}

Connecting to a client

Tinkered with connecting this server to a simple Apollo/React client app here: https://github.com/jessicamcinchak/frontpage-react-app/tree/ledger-client