gu-gridh / arosenius-archive-gui Goto Github PK

View Code? Open in Web Editor NEW

1.0 6.0 1.0 208.87 MB

JavaScript 54.56% CSS 1.49% HTML 15.70% Less 28.24%

arosenius-archive-gui's Introduction

The Ivar Arosenius archive frontend

A React.js frontend for the Ivar Arosenius online archive (https://aroseniusarkivet.dh.gu.se/).

The frontend connects to a backend whose source code can be found here: https://github.com/CDH-DevTeam/arosenius-api

There is also an administration frontend for editing the data: https://github.com/CDH-DevTeam/arosenius-admin

Getting started

To build the archive from the source code, first clone the repository or fork it to your own repository. Then install all JS dependencies and finally build the site. Node 11 or lower is required (12 will not work).

git clone https://github.com/CDH-DevTeam/arosenius-archive-gui.git
cd arosenius-archive-gui
nvm use # or otherwise make sure you are using Node <=11
yarn install
# Create scripts/config.js (see below)
yarn dev
# Visit www/index.html in a web browser

Gulp outputs www/scripts/app.js and www/css/style.css. The site entry point is www/index.html; open it directly in a web browser or serve it with Nginx or similar.

When using yarn dev, the build process keeps watching source files and rebuilds instantly on changes.

Config file

The scripts/config.js file must include some configuration needed to run the archive. The apiUrl and adminUrl urls are expected to serve the aforementioned backend and administration frontend, respectively. The endpoints parameters must agree with the routes specified in the backend code.

export default {
	apiUrl: '[url]/', // link to the projects API
	imageUrl: '[api url]/images/', // link to the base image folder of the projects API
	adminUrl: '[url]', // link to the projects Administration system
	endpoints: { // API endpoints for various datatypes
		documents: 'documents',
		document: 'document/',
		autocomplete: 'autocomplete',
		tags: 'tags',
		persons: 'persons',
		places: 'places',
		genres: 'genres',
		museums: 'museums',
		types: 'types',
		year_range: 'year_range',
		tag_cloud: 'tags/cloud'
	}
};

Deploying

Clone the repo to the server, create scripts/config.js and run the build. (Again, make sure to use Node <=11.)

cd arosenius-archive-gui
git pull
nvm use
yarn install
yarn build

Populate the www/nearest_neighbors and www/tsne_data directories with data from arosenius-nearest-neighbors (see instructions there).

arosenius-archive-gui's People

Contributors

Stargazers

Watchers

Forkers

jonathanwestin

arosenius-archive-gui's Issues

Hide "Inga sökträffar" when there are no similar images

From: http://aroseniusarkivet.org/#/image/GUB-3395

This happens when a new image is added, but the data for similar images (from https://github.com/CDH-DevTeam/arosenius-nearest-neighbors) has not been generated. Hide "Inga sökträffar" along with the title.

Carousel for series

For the keyword type series, images are ordered (by title). The ordinary masonry-based gallery does not communicate this order very well. A carousel would be better, with the current image indicated.

Current view:

Related gallery "Visa alla" for tags has wrong url

The image display page features several galleries of related images. If there are many images, the gallery has a Visa alla link. For tag-based galleries, that link is wrong: it has tags/tag where it should have tags/tags

This image: https://aroseniusarkivet.dh.gu.se/#/image/290
under Fler objekt relaterade till klänning
links to: https://aroseniusarkivet.dh.gu.se/#/search/tags/tag/Kl%C3%A4nning
It should link to: https://aroseniusarkivet.dh.gu.se/#/search/tags/tags/Kl%C3%A4nning

Flag images that should only appear in main gallery

As some images are a perhaps a bit sensitive, it would be good if they were not included in suggestions (the mini-galleries below another work of art). If there was a flag that said something like "Controversial", so controversial images could be marked, then perhaps it would be possible to hide them (or not include them at all) in the mini-galleries?

Tidslinje does not include all objects from a certain year

To reproduce:

go to tidslinje and 1908
notice that there are only a few images from the Lillans Kattresa (publicerad) series. Instead of 16 there are only 3-4.

See if there is an artificial limitation for number of documents that can be shown. And: it would be better if the documents of each year were ordered alphabetically.

Enable searching on material, such as "Oljemålning"

Series with more than 10 images appear in wrong order

When a series of images (Kattresan is the only one I have found) has more than 10 images, the following thing happens:

the series-gallery displays them in the wrong order since it is based on the names of the individual painting. i.e "Lillans kattresa (1 av 32)" is followed by Lillans kattresa (10 av 32) instead of Lillans kattresa (2 av 32).
the series gallery only displays ten images, so the rest of the images (21 in total) is not accessible

Include backside in mini gallery under main image

Records with multiple images feature a mini gallery under the main image: https://aroseniusarkivet.dh.gu.se/#/image/652

However backsides are being excluded, e.g: https://aroseniusarkivet.dh.gu.se/#/image/290

Include them.