The Pulter Project Central

Welcome

This repository contains the codebase of The Pulter Project. Two image collections are included in the form of submodules:

• Poem Poster Images
• Manuscript Facsimile Images

Encoders

Style Guide

This collection of pages provides guidance on various aspects of TPP content encoding.

Files

These are the folders of interest for the contributing parties (encoders, editors, etc.):

• /pulter-poems — TEI XML encoded poems, the gold;
• /pulter-site/pages — static pages of the site;
• /pulter-site/curations — poem curations (HTML pages);
• /pulter-site/explorations — explorations (HTML pages).

Developers

Local Setup

1. Make sure your machine has Node.js (use nvm to manage multiple Node versions)
2. Install gulp-cli tool globally: npm install gulp-cli -g.
3. Install Yarn.
4. Run yarn.

Available CLI Commands

• gulp — boots up the development web server with automatic JS/CSS compilation and browser reloading; this it the default mode for active development;
• gulp xslt:poems — builds an array of HTML pages representing the whole corpus of the poems and their editions; the generated structure goes under /poems;
• gulp xslt:poems:ae --single 'pulter_078.xml' — run the transformation for a single poem;
• gulp xslt:manifest — builds JSON manifest (/pulter-manifest.json) of the poems;
• gulp xslt:index — builds the main index page;
• gulp xslt:search — builds the search functionality;
• gulp xslt — runs all the commands from xslt namespace; re-compiles the whole site;
• gulp build — builds a production version of the site and puts it in /dist.

Deployments

Development Instance

Branch develop is built and deployed to the "preview site" on every push that changes files in these folders: ./pulter-poems and ./pulter-site. Encoder may choose to skip the build by including [skip ci] in the commit message.

It is also possible to deploy directly to Netlify by running npm run build; netlify deploy -p -d dist/;.

Staging Instance

Branch master is automatically deployed to the AWS S3 staging site. This instance is used to verify that the build you are about to deploy to prod looks/works as intended.

Production Instance

Branch master is deployed to the AWS S3 production site upon review of the staging site and a sign-off from @sergei-kalugin or @emwitty.

Current Delta

This keeps track of an important difference between deployments. Below is the content published on the preview site but not on the production site.

Poems

—

Curations

C069a (Identifying Pulter’s Fabulous Flowers),

Explorations

—