kingsdigitallab/alice-thornton

Repository for the Alice Thornton Digital Edition project

Alice Thornton project code

Open in Gitpod: design branch | develop branch

The web site is developed using a Static Site Generator called 11ty.

• Documentation for editors
• Documentation for developers

Site deployment

• The live site is generated from the main branch every 10 minutes. Researchers can edit the markdown content of the site directly on this branch.
• The staging site is generated from the release branch every 10 minutes. This branch and site are used by the KDL team to test and demonstrate new features and fixes before publishing them to main branch.
• The development site is generated from the develop branch every 30 minutes. This branch and site are used by the KDL team to experiment with new, unstable features.

Edition

• The TEI editions of the books are kept in the edition branch
• The HTML chunks are generated from the TEI editions every day at 1pm & 6pm and saved into the dts branch (Use github action or npm run tei2html to run it manually.)
• The Text Viewer reads HTML chunks from the dts branch
• The development site shows the latest HTML chunks
• Snapshots of the dts branch will be manually tagged with following format: 'eYYYY-MM-DD', example 'e2023-05-23'

Developing the DTS server

To edit the code of the DTS server locally while testing it with the AT Text Viewer on the AT edition:

1. git clone kdl-dts-server in a new folder outside the project
2. Start the server: npm run start:at (will run on localhost:3000)

Server build for each type (dev|stg|liv) of site:

export SITE_ENV='dev'; npm run rebuild