mirror of
https://github.com/SwissFederalArchives/chgov-brprotokolle-frontend.git
synced 2026-08-26 01:14:22 +00:00
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%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github | ||
| dist-pkg | ||
| doc | ||
| public | ||
| src | ||
| .babelrc | ||
| .env.example | ||
| .gitignore | ||
| .gitmodules | ||
| .nvmrc | ||
| .prettierrc | ||
| changelog.md | ||
| Dockerfile | ||
| LICENSE | ||
| package.json | ||
| readme.md | ||
| tsconfig.json | ||
| tsconfig.prod.json | ||
| tslint.json | ||
| untyped.d.ts | ||
| webpack.config.js | ||
| yarn.lock | ||
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
- Make sure the git submodules are installed properly
git submodule install
- Install correct Node version defined in
.nvmrc
nvm install
- Using the correct Node version
nvm use
- Install yarn globally for given node version
npm i -g yarn
- Install Node dependencies
yarn
- Define a proper
.envby using.env.exampleas reference.
Static build
- The following command creates a static build in the
./distdirectory
yarn build
Customization
General
- Make sure your
.envfile 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.