HiT-Histories in Transition

HiT-Astro is an application for managing and interacting with a collection of manuscripts and historical data, built using Astro. For more on the project itself see the about page as well as the project site in the ACDH website.

Table of Contents

• Datamodel
• Getting Started
• Project Structure
• License

Datamodel

This project uses the data model defined in dbdiagram.io to organize and store manuscripts, codicological units, manuscript items, works, authors, genres, and related metadata. To suit the researchers' aim the data is entered in a relational database baserow. This data is dumped on a regular basis in a sister repository. The JSON files are then processed in the current repository, making visualizations and advanced filtered search possible.

Getting Started

Prerequisites

1. Package Manager: This project uses pnpm. If you haven't installed it:

   npm install -g pnpm

2. Clone the repo

   git clone https://github.com/histories-in-transition/hit-astro.git
   cd hit-astro

3. Installation

   1. Install dependencies:

      pnpm install

   2. Configure the application: Currently the application uses a base path: 'hit-astro' set in astro.config.mjs
   3. To run the project locally:

      pnpm run dev

Project Structure

• src/content/: Contains collections and JSON data files (fetched using the scripts in the scripts folder).
• src/components/: Contains astro components such as header, footer etc.
• src/pages/: Contains the web pages to tables (of manuscripts, works etc.) or detail view of single items (manuscripts, works etc).
• src/lib/: Contains scripts for the advanced search, and the Tabulator library used to display JSON data in tables.
• src/lib/advanced search and src/pages/search.astro (search interface): Implements the search page with (Algolia) instant search (using Typsesence instance search adapter).
• scripts/: Scripts for fetching data.

License

This project is licensed under the MIT License.