Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.57 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.57 KB

restaurant-inspections

Search restaurant inspection data from the Detroit Health Department.

Built with Gatsby, a static-site generator for React & GraphQL.

Data

We're using the gatsby-source-pg plugin to query data from PostgreSQL. Find a database dump in src/data/restaurants.sql.bz2.

Assuming you have PostgreSQL installed locally, import the db dump from your shell:

createdb restaurants
psql -d restaurants -c 'create extension postgis'
bunzip2 restaurants.sql.bz2
psql -d restaurants < restaurants.sql
psql -d restaurants < functions.sql

You'll find three tables in the public schema: establishments, inspections and violations. An establishment can have many inspections, and an inspection can have many violations. Following the PostGraphile docs, we've pre-defined indexes, foreign key constraints, and postgres functions.

For example, this function matches restaurants on name and returns a list:

create or replace function search_establishments(input text) returns setof establishments 
  as $$ select * from establishments
    where name ilike ('%' || input || '%')
  $$ language sql stable;

It translates to this handy GraphQL query:

{
  searchEstablishments(input: "taqueria") {
    edges {
      node {
        establishmentid
        name
        address
      }
    }
  }
}

This data is also available on Detroit's open data portal.

Develop

Install Gatsby CLI globally: npm install --global gatsby-cli

Define your database connection string in .env.development:

PG_CONN=postgres://{user}:{password}@{host}:{port}/{dbname}

yarn install installs depenedencies

gatsby develop starts the development server and GraphiQL, an in-browser IDE for our site's data

Deploy

Create .env.production and define a database connection string

Run yarn deploy from the master branch to deploy to gh-pages

Styling

We're using React Semantic UI with Less.

Customize Semantic UI by editing files in src/semantic/site. This customization guide explains that file structure.

This starter was a helpful guide for installation.

Helpful links