fitzwilliammuseum / fitz-collection-online

A repository to hold the code for the front end/API of the Fitzwilliam Museum's Collections Explorer

Fitzwilliam Museum Collection front end

This repository contains the code base for a Laravel based front end for the production version of the Fitzwilliam Museum collection application.

This is very much a minimum viable product and to run and install your environment would need to be whitelisted for our solr, axiell, directus, shopify and elastic api instances.

This system is built with the latest versions of Bootstrap and Laravel and uses webpack/npm.

Requirements

PHP 8.1 Node 18.17.0

Installation

1. Install php on your development environment
2. Install composer
3. Install Node and NPM
4. Then run:

$ git clone https://github.com/FitzwilliamMuseum/fitz-collection-online
$ cd fitz-collection-online
$ composer install
$ npm install
$ npm run production
$ cp .env.example .env

You should now have all the source code installed, and you will then need to edit the .env file to hold all the values required. If you work for the Fitz, you will need to grab this from our Bitwarden vault.

Once you are set up, to run locally:

$ php artisan serve

License

This project's code is licensed under GPL V3

Contributors

Daniel Pett @portableant

Cite this repository

APA style

Pett, D. The Fitzwilliam Museum Collections and API Website Framework [Computer software]. https://github.com/FitzwilliamMuseum/fitz-collection-online

Bibtex style

@software{Pett_The_Fitzwilliam_Museum, author = {Pett, Daniel}, license = {AGPL-3.0}, title = {{The Fitzwilliam Museum Collections and API Website Framework}}, url = {https://github.com/FitzwilliamMuseum/fitz-collection-online} }

fitz-collection-online's Issues

Add linked art

As part of the linking islands of data project, we said we would add linked art to the project

Partner logos - responsive fix

Change the logos to match code of main site

Add object location

Add a component to say where object is eg storage or gallery number

3D sketchfab embed too small

Increase size

Change IIIF to use version UV4

Upgrade npm and reconfigure the embeds

Add citation file

Pagination broken in mobile display

Laravel framework update broke page layout for pagination.

Legacy dump call in API registration form

Within the register blade file, a dump call to debug errors wasn't removed before the API went live in 2022.

Simple remove of this line will fix this:

fitz-collection-online/resources/views/auth/register.blade.php

Line 72 in a8c5dc9

@dump($errors)

Slow looking IIIF css missing

Before I left I made a large commit and forgot to commit one file - the viewer css. At the moment you get the below - an unstyled page, not very slick...

When it should look like:

The missing file is viewer.css and that will be added in a PR that is coming.

Wine colour button issues

Wine colour button does not work properly in bs-5

Drop fontawesome

Remove font awesome and go local

Add 3d to api calls

Rogue DD in view

I am very interested in having a look at the folio 66r of MS McClean 180. I've found that it's digitilized (https://data.fitzmuseum.cam.ac.uk/id/object/93606); however, when I press "view all 68 images attached", the link seems to be broken.

Move from Klaro

Change cookie management system to cookie consent vanilla js project

Upgrade from 7 to 8 for elastic search

Breaking changes introduced between the branches of the elastic search system.

IIIF layout view uses BS 4.5

Upgrade view to use BS 5 and fix jQuery error

Contact form needs reformatting

Upgrade for bootstrap 5

Out of date sponsors logos

The sponsor partner logos are incorrect, must match the main site

Fix 3d objects not rendering as a button

Linked Art representation - 404 on agents

Within the linked art representation, a routing error was made - terminology rather than agents was used. Thus this code block is rendered:

"carried_out_by": [
      {
        "id": "https://data.fitzmuseum.cam.ac.uk/id/terminology/agent-161737",
        "type": "Person",
        "_label": "Trajan (AD 98-117)",
        "referred_to_by": [
          {
            "id": "https://data.fitzmuseum.cam.ac.uk/id/object/104030/maker/ccb09c30-adb3-3185-b5b4-e784e6fb613b",
            "type": "Type",
            "_label": "Ruler",
            "classified_as": [
              {
                "id": "https://data.getty.edu/local/thesaurus/producer-role-statement",
                "type": "Type",
                "_label": "Artist/Maker (Producer) Role Statement"
              },
              {
                "id": "http://vocab.getty.edu/aat/300418049",
                "type": "Type",
                "_label": "Brief Text"
              }
            ],
            "content": "Artists (Visual Artists)",
            "close_match": {
              "id": "http://vocab.getty.edu/aat/300025103",
              "type": "Type",
              "_label": "Artists (Visual Artists)"
            }
          }
        ],
        "close_match": [
          "https://nomisma.org/id/rome",
          "https://sws.geonames.org/3169070",
          "https://www.wikidata.org/entity/Q220",
          "https://pleiades.stoa.org/places/423025",
          "http://vocab.getty.edu/page/tgn/7000874"
        ]
      }

This should render as:

"carried_out_by": [
      {
        "id": "https://data.fitzmuseum.cam.ac.uk/id/agent/agent-161737",
        "type": "Person",
        "_label": "Trajan (AD 98-117)",
        "referred_to_by": [
          {
            "id": "https://data.fitzmuseum.cam.ac.uk/id/object/104030/maker/ccb09c30-adb3-3185-b5b4-e784e6fb613b",
            "type": "Type",
            "_label": "Ruler",
            "classified_as": [
              {
                "id": "https://data.getty.edu/local/thesaurus/producer-role-statement",
                "type": "Type",
                "_label": "Artist/Maker (Producer) Role Statement"
              },
              {
                "id": "http://vocab.getty.edu/aat/300418049",
                "type": "Type",
                "_label": "Brief Text"
              }
            ],
            "content": "Artists (Visual Artists)",
            "close_match": {
              "id": "http://vocab.getty.edu/aat/300025103",
              "type": "Type",
              "_label": "Artists (Visual Artists)"
            }
          }
        ],
        "close_match": [
          "https://nomisma.org/id/rome",
          "https://sws.geonames.org/3169070",
          "https://www.wikidata.org/entity/Q220",
          "https://pleiades.stoa.org/places/423025",
          "http://vocab.getty.edu/page/tgn/7000874"
        ]
      }

Simple fix for this within two files - app/LinkedArt/ObjectOrArtwork.php and app/LinkedArt/Production.php with the route changed from

'id' => route('terminology', ['id' => $maker['admin']['id']]),

to

'id' => route('agent', ['id' => $maker['admin']['id']]),

Log files - configure for daily creation

Upgrade bootstrap libraries

Bring this application in line with the main fitzwilliam website.

Move breadcrumbs to diglactic

Add super tiny icons

Change blade templates to use Terence Eden's Super tiny icons project https://github.com/edent/SuperTinyIcons

Fix footer SVG colours

Change to blade icons, change to black
Fix badge margins for exif

API pagination problem

Last page not rendering - change offset method (d'oh)

Change back to top library

Change to more simple back to top implementation

Install csspurge for webpack

Optimise css used on site

Install bootstrap 5.2

Upgrade framework, remove alpine and vue

Upgrade solarium

Change library in composer to latest edition

Change default timezone for app

The system timezone is defaulting to UTC, change to Europe/London. The timezone for this project can only ever be in that zone, the Museum's location will never change.

Bootstrap change - floats

Float right/left deprecated, change to float end/start

Dimension Drawing functions breaks with strings

Add numeric test

Change specifics of location

Make less verbose

Slow viewer css broken

Drop jQuery

Now that the framework migrated to Bootstrap 5, no need for jQuery

Upgrade to laravel 9

Change version of framework and upgrade dependencies

Footer responsive design

Change footer code for text based links to match the main website