chgov-brprotokolle-frontend

• chgov-brprotokolle
  • chgov-brprotokolle-server
  • chgov-brprotokolle-markdown
  • chgov-brprotokolle-frontend 🚩
  • chgov-brprotokolle-ocr

Context

This software is an open-source and web-based viewer for IIIF.

Architecture and components

It is focused on tree views but also works with single manifests. The viewer was developed for the Archival IIIF Server, but also works with any other IIIF server.

• IIIF Image API 2 & 3
• IIIF Presentation API 2 & 3
• IIIF Authentication API
• IIIF Search API

First steps

Preparations

• Install Node.js
• Install NVM
• Install yarn

Install

1. Make sure the git submodules are installed properly

git submodule install

2. Install correct Node version defined in .nvmrc

nvm install

3. Using the correct Node version

nvm use

4. Install yarn globally for given node version

npm i -g yarn

5. Install Node dependencies

yarn

6. Define a proper .env by using .env.example as reference.

Static build

• The following command creates a static build in the ./dist directory

yarn build

Customization

General

• Make sure your .env file is properly defined

Run tests

• There currently are no automated tests available.

Execute

• Start development process in watch-mode

yarn start

Authors

• Schweizerisches Sozialarchiv
• 4eyes GmbH

License

GNU Affero General Public License (AGPLv3), see LICENSE

Contribute

This repository is a copy which is updated regularly - therefore contributions via pull requests are not possible. However, independent copies (forks) are possible under consideration of the The MIT license.

Contact

• For general questions (and technical support), please contact the Swiss Federal Archives by e-mail at bundesarchiv@bar.admin.ch.
• Technical questions or problems concerning the source code can be posted here on GitHub via the "Issues" interface.