Under the Surface
The Under the Surface project combines a data-set with management scripts for a simple, static digital archive. In this specific instance, the archive is targeted at surfacing authors, composers, and artists who have sunk under the canonical surface.
The following dependencies must be installed as pre-requisites:
- Python 3
To run and build the Under the Surface site, use the instructions below, depending on the environment.
To build in production mode, run the following commands in sequence:
Alternatively you can run the
build.sh script to fully automatically pull the latest changes, install all
dependencies, and rebuild the site. Any specific code that needs to be run must be placed in a file
local-config, which will automatically be sourced at the start of the script. Similarly any commands to
be run after the build, must be placed in a file
post-build which is automatically run after the build completes.
To build in development mode, run the following commands in sequence:
yarn install --dev
start a webserver at http://localhost:8080. To terminate the builders, press