Skip to content

About

Public site for the CROSSREADS research project

Topics

Resources

Stars

0 stars

Watchers

3 watching

Forks

Repository files navigation

Build and deploy

This is the code base for I.Sicily, its new web application and data processing infrastructure, developed by King’s Digital Lab as part of the Crossreads research project.

Corpus Building

This project code base processes EpiDoc TEI XML files and presents them as a static website.

It uses a monorepo structure with two main components: an ETL (Extract, Transform, Load) process for handling XML files, and a web application for presenting the processed data.

Project structure

The main components of the code base are:

  • packages/
    • etl/: ETL package for processing XML
  • frontend/: Static site generator web application
  • data/
    • processed/: Output data generated by the etl package after processing the raw data
    • raw/: Git submodule for the EpiDoc files
  • xslt/
    • epidoc/: Git submodule for XSLT stylesheets
    • start-edition.sef.json: Compiled version of the XSLT to convert the XML files into HTML

Workflow

graph TD
A[EpiDoc Submodule] --> B[ETL Process]
X[XSLT Submodule] --> B
Z[Zotero API] -.->|Fetch Citations| B
B -->|Transform XML| C[Saxon-JS]
C -->|HTML Fragments| D[Processed HTML]
B -->|Extract Data| E[JSON Files]
D --> F[Static Site Generator]
E --> F
G[Markdown Files] -.-> F
F -->|Generate Pages| H[Static HTML]
E -.->|Search Index| F
H -.-> I[Inscriptions]
H -.-> K[Search and Filters]
H -.-> J[Interactive Visualisations]
H -.-> L[Open Data Endpoints]
Loading

Prerequisites

Getting started

  1. Clone this repository

  2. Initialise and update the submodules

    git submodule update --init --recursive
  3. Install dependencies

    npm install
  4. Run the etl process

    npm run etl
  5. Run the development server

    npm run frontend:dev

The project should be available at http://localhost:5173/.

Testing

The project uses a comprehensive testing strategy covering pure functions (Vitest) and end-to-end integration/accessibility (Playwright).

To run all tests across the entire monorepo (both ETL and frontend):

npm test

You can also run tests for specific workspaces from the root:

  • npm run test:etl — Run ETL unit tests only
  • npm run test:frontend — Run all frontend tests (unit + integration)
  • npm run test:integration — Run Playwright frontend integration/accessibility tests only

Editorial and Release Workflows

More information about Editorial and Release Workflows.

How to cite

@software{King_s_Digital_Lab_and_Vieira_Corpus_building_edition_2026,
author = {{King's Digital Lab} and Vieira, Miguel and Lu, Zihao and Ciula, Arianna and Prag, Jonathan},
license = {MIT},
month = jun,
title = {{Corpus building edition}},
url = {https://github.com/kingsdigitallab/corpus-building},
version = {v0.27.2},
year = {2026}
}

(Generated from codemeta.json)

Aknowledgements

This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 885040, “Crossreads”).

About

Public site for the CROSSREADS research project

Topics

Resources

Stars

0 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages