Read-only mirror of https://github.com/SwissFederalArchives/chgov-brprotokolle-frontend — Schweizerisches Bundesarchiv. Issues & pull requests at the source.
  • TypeScript 89.8%
  • CSS 8.5%
  • HTML 0.8%
  • JavaScript 0.8%
  • Dockerfile 0.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2023-11-14 10:45:24 +01:00
.github Create codeql-analysis.yml 2021-05-08 09:59:23 +02:00
dist-pkg Initial release 2023-02-16 10:33:06 +01:00
doc Initial release 2023-02-16 10:33:06 +01:00
public BRP-79: Implements changes for marginalia search 2023-11-03 09:57:20 +01:00
src BRP-79: Fixing Tooltip font-size styling 2023-11-14 10:45:24 +01:00
.babelrc craco/cra4 -> webpack 5, closes #187, refs #184 2022-09-07 19:55:58 +02:00
.env.example Initial release 2023-02-16 10:33:06 +01:00
.gitignore BRP-72: Reimplementing search, adding full text search for marginalia and decision number 2023-06-26 11:05:20 +02:00
.gitmodules Merge remote-tracking branch 'upstream/master' into main 2023-06-07 17:02:21 +02:00
.nvmrc BRP-43: Update text labels 2023-09-26 14:12:04 +02:00
.prettierrc BRP-72: Reimplementing search, adding full text search for marginalia and decision number 2023-06-26 11:05:20 +02:00
changelog.md v3.1.0 2023-01-30 14:29:08 +01:00
Dockerfile Adds a Dockerfile 2022-08-23 14:42:44 +02:00
LICENSE Initial commit 2018-04-28 11:02:56 +02:00
package.json BRP-70: Security fixes 2023-11-10 09:55:31 +01:00
readme.md Merge remote-tracking branch 'upstream/master' into main 2023-06-07 17:02:21 +02:00
tsconfig.json Merge remote-tracking branch 'upstream/master' into main 2023-06-07 17:02:21 +02:00
tsconfig.prod.json Initial release 2023-02-16 10:33:06 +01:00
tslint.json BRP-70: Replaced 'search' class components with func components 2023-06-19 09:08:27 +02:00
untyped.d.ts Initial release 2023-02-16 10:33:06 +01:00
webpack.config.js Merge remote-tracking branch 'upstream/master' into main 2023-06-07 17:02:21 +02:00
yarn.lock BRP-70: Security fixes 2023-11-10 09:55:31 +01:00

chgov-brprotokolle-frontend

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.

First steps

Preparations

Install

  1. Make sure the git submodules are installed properly
git submodule install
  1. Install correct Node version defined in .nvmrc
nvm install
  1. Using the correct Node version
nvm use
  1. Install yarn globally for given node version
npm i -g yarn
  1. Install Node dependencies
yarn
  1. 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

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.