EditionCrafter Project React Template

This repository provides a starting point for creating an Astro website using EditionCrafter. It comes with a number of pre-configured examples and step-by-step instructions for configuring your own edition. If you are familiar with web software development, follow the installation instructions to set up your development environment. If you want to get started without setting up a local development environment, this repo is configured to work with GitHub CodeSpaces. The code space comes with the latest EditionCrafter Command Line Interface (CLI) and other dependencies pre-installed. Simply fork this repo and then click on the CodeSpaces button.

Installation

This is a Javascript based project and you will need Node.js v18 or higher to run it locally. First, clone this repository and then run:

npm install

Then, install the EditionCrafter CLI:

npm install -g @cu-mkp/editioncrafter-cli

Next, follow the initial setup instructions below.

Initial Setup

To setup setup your project:

1. Edit the astro.config file, replacing BASE_DIR with your project base directory. For local installation, this is "."

2. Edit the data/config.json file. Fill in the DOCUMENT_NAME, BASE_DIR, and DOCUMENT_ID. You may also need to adjust the transcriptionTypes depending on your document. For more information, please see the "Getting Started" section of the EditionCrafter website.

Exploring the Example Documents

This project comes with a number of pre-built example documents for you to try out. Simply replace data/config.json with one of these alternative config files:

• fr640-config.json : Demonstrates the use of the EditionCrafter component using the folio 3r from Secrets of Craft and Nature
• fr640-entries.json : Demonstrates the use of the EntryList component in tandem with the EditionCrafter component.
• cary-config.json : This demonstrates the use of zones in the surface images.

Getting Started with EditionCrafter CLI

To learn how to use the EditionCrafter CLI to create your own project, please see the "Getting Started" section of the EditionCrafter website. Note that the props passed into the components are configurable via the data/config.json file.

Running this Project Locally

To run locally, set the BASE_DIR in the steps above to "."

Then use the following command:

npm run start

Upgrading EditionCrafter

This repository contains the latest version of EditionCrafter. To upgrade to a newer version in the future, run the following command:

npm install @cu-mkp/editioncrafter@latest

Then, upgrade the EditionCrafter CLI using this command:

npm install @cu-mkp/editioncrafter-cli@latest

Credits

Developed by the Making and Knowing Project at the Center for Science and Society at Columbia University and Performant Software Solutions LLC. Funded by Grant SES-2218218 from the National Science Foundation.