Letters 1916

• data is fetched from https://github.com/letters1916static/letters1916-data
• build with DSE-Static-Cookiecutter

initial (one time) setup

• run ./fetch_data.sh
• run ant

Note

The build.xml triggered by the ant command presumes the following folder-file structure in the data repo:

data/
├── editions/
│   ├── *.xml
│   ├── *.xml
│   └── *.xml
├── indices/
│   ├── listbibl.xml
│   ├── listorg.xml
│   ├── listperson.xml
│   └── listplace.xml
└── meta/
    └── about.xml

Otherwise, modify the relevant lines of the build.xml.

set up GitHub repo

• create a public, new, and empty (without README, .gitignore, license) GitHub repo https://github.com/letters1916static/letters1916-static
• run git init in the root folder of your application letters1916-static
• execute the commands described under …or push an existing repository from the command line in your new created GitHub repo https://github.com/letters1916static/letters1916-static

start dev server

• cd html/
• python -m http.server
• go to http://0.0.0.0:8000/

publish as GitHub Page

• go to https://https://github.com/letters1916static/letters1916-static/actions/workflows/build.yml
• click the Run workflow button

dockerize your application

• To build the image run: docker build -f docker/Dockerfile -t letters1916-static .
• To run the container: docker run -p 80:80 --rm --name letters1916-static letters1916-static

Licenses

This project is released under the MIT License

third-party JavaScript libraries

The code for all third-party JavaScript libraries used is included in the html/vendor folder, their respective licenses can be found either in a LICENSE.txt file or directly in the header of the .js file

SAXON-HE

The projects also includes Saxon-HE, which is licensed separately under the Mozilla Public License, Version 2.0 (MPL 2.0). See the dedicated LICENSE.txt

letters1916-static