Técnico Application

Based off of the Vercel Postgres + Prisma Next.js Starter. This utilizes the following tools:

• Next.js - React.js framework
• Prisma - database modeling/ORM
• Tailwind - CSS framework

Data Submission

Data is modeled with the following concepts:

• Study
• Theme: Belongs to study, represents a field of research for a given study.
• Scenario: A way that would modify the outcome of a study.

To provide data, three files must be provided:

1. A XLSX spreadsheet file for a study, named {study_identifier}.xlsx
2. A gzipped GeoJSON file containing geometries associated with the study, named {study_identifier}.geojson.gz
3. A MDX (with a .md extension) file describing the content for the study details page

Study Spreadsheet

[!TIP] A template for a study spreadsheet can be downloaded here.

The study spreadsheet must contain the following worksheets. Column/key names are case insensitive and asterisks are removed prior to ingestion. Coumns/keys with that contain "ignore" are ignored.

• study: metadata about the study. Formatted in key, value format.
  • Keys
  • Name: Text, required;
  • Description: Text, required;
  • Image Src: URL, optional;
  • Details: Text, optional;
  • Scale: 'Municipality' or 'Building', required;
  • Geom Key Field: Text, required; must match a property key present in geometry GeoJSON file
  • Metrics Key Field: Text, required; must match a column name present in metrics tab
  • Highlight: boolean, optional;
• metrics: raw data. The following conditions must be met:
  • Each metric must have a corresponding geometry in the accompanying geometry file. This is determined by matching the value at the column specified by the Metrics Key Field to the value of the geometery's property at the Geom Key Field.
• metrics_metadata:
  • Columns
  • field_name: Text, required;
  • description: Text, required;
  • units: Text, required;
  • theme: Text, required;
  • scenario: Text, required; leave blank to indicate baseline scenario
  • category: Text, required; blank values are interpreted as "all"
  • usage: Text, required; blank values are interpreted as "all"
  • source: Text, required; blank values are interpreted as "all"
• scenarios_metadata
  • Columns
  • scenario: Text, required; Identifier for scenario
  • description: Text, required; Description of scenario

Study Geometries

• FeatureCollection of Polygon or MultiPolygon values.
• Each Feature must contain a unique id property of either a string or integer.
• Features that are not referenced by a metric in the study spreadsheet will be logged and ignored at time of ingestion.

Study Details Markdown

• it is possible to include MDX content in html tags (e.g. <img src="https://github.com/Dashboard-IN3/tecnico-energy-app/raw/main/.." width="..." alt="..." />)
• The markdown content needs to follow standard markdown syntax as described in Markdown Guide

Development

Install

pnpm install

Setup database

To do a quick and dirty setup of our dev db (not using migrations):

# Push our DB schema to database
pnpm prisma db push

See Schema prototyping with db push for more information.

Load data

Seeding

Seeding the database is the conventional entry to loading data into our application. Run it via:

pnpm prisma db seed

Data Model

Buildings

To turn our Shapefile of buildings (shapefile.shp) in EPSG:32729 into a GeoJSON in EPSG:4326:

ogr2ogr -f GeoJSON -s_srs EPSG:32729 -t_srs EPSG:4326 buildings.geojson shapefile.shp

To insert these records into our local database:

# Convert our geojson to a CSV of building name, geometry, & properties (without building name) and pipe to postgres database
cat data/buildings.geojson | jq -r '.features[] | .properties.Name + ";" + (.geometry | tojson) + ";" + (del(.properties.Name) | .properties | tojson)' | psql tecnico -c "copy buildings from stdin (delimiter ';');"

You should see something like COPY 5193 as output.

Exploring data

Prisma ships with a Prisma Studio. It can be run via:

pnpm prisma studio

Running the Application

Run Next.js in development mode:

pnpm dev

Deploy it to the cloud with Vercel (Documentation).

Previewing Compiled Markdown content

• running pnpm contentlayer build will pull from the mdx files in the data directory. The compiled files will overwrite the content in the .contentlayer directory.