Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cityofdetroit/restaurant-inspections
Search restaurant inspections open data
https://github.com/cityofdetroit/restaurant-inspections
Last synced: 6 days ago
JSON representation
Search restaurant inspections open data
- Host: GitHub
- URL: https://github.com/cityofdetroit/restaurant-inspections
- Owner: CityOfDetroit
- License: mit
- Created: 2019-03-02T16:48:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-07T16:31:42.000Z (about 1 year ago)
- Last Synced: 2024-04-14T07:56:38.821Z (7 months ago)
- Language: JavaScript
- Homepage: https://cityofdetroit.github.io/restaurant-inspections/
- Size: 216 MB
- Stars: 3
- Watchers: 11
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```bash
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](https://www.graphile.org/postgraphile/introduction/), we've pre-defined indexes, foreign key constraints, and postgres functions.
For example, this function matches restaurants on name and returns a list:
```psql
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:
```gql
{
searchEstablishments(input: "taqueria") {
edges {
node {
establishmentid
name
address
}
}
}
}
```
This data is also available on [Detroit's open data portal](https://data.detroitmi.gov/browse?q=restaurants).
## 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](http://learnsemantic.com/developing/customizing.html) explains that file structure.
This [starter](https://github.com/pretzelhands/gatsby-starter-semantic-ui) was a helpful guide for installation.
## Helpful links
- [Gatsby documentation](https://www.gatsbyjs.org/)
- [gatsby-source-pg plugin](https://www.gatsbyjs.org/packages/gatsby-source-pg/)
- [PostGraphile documentation](https://www.graphile.org/postgraphile/)
- [React Semantic UI](https://react.semantic-ui.com/)