Skip to content
The Under the Surface project combines a data-set with management scripts for a simple, static digital archive.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
content
docs
i18n
js
scripts
styles
theme
.gitignore
LICENSE
Pipfile
Pipfile.lock
README.md
babel.cfg
build.sh
cgi-build.sh
click
filters.py
gulpfile.js
i18n_install.py
package.json
pelicanconf.py
person_reader.py
publishconf.py
publishconf_de.py
publishconf_en.py
runner.py
yarn.lock

README.md

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.

Dependencies

The following dependencies must be installed as pre-requisites:

  • Python 3
  • Pipenv
  • Yarn

Running

To run and build the Under the Surface site, use the instructions below, depending on the environment.

Production

To build in production mode, run the following commands in sequence:

  • export PIPENV_VENV_IN_PROJECT=True
  • pipenv install
  • yarn install
  • ./runner.py

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 called 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.

Development

To build in development mode, run the following commands in sequence:

  • export PIPENV_VENV_IN_PROJECT=True
  • pipenv install
  • yarn install --dev
  • ./runner.py -d

These will start the builders in automatic content re-build mode, automatic styling and javascript re-build mode, and start a webserver at http://localhost:8080. To terminate the builders, press CTRL+C.

You can’t perform that action at this time.