University of Arizona Libraries Customizations For LibApps

This repository contains customizations for LibApps for the University of Arizona Libraries. The styles here are intended to match UA Sites.

People

This repository is primarily intended for use by the members of Research & Learning, in particular Jennifer Church-Duran, Leslie Sult, and Nicole Hennig.

Quickstart

0. Ensure that the "Custom JS/CSS" section under "Look & Feel" in the LibApps Group or Application you're trying to customize is loading the appropriate files:

<link rel="stylesheet" type="text/css" href="https://libapps.cloudsites.arizona.edu/main.css">
<script src="https://libapps.cloudsites.arizona.edu/vendor.js"></script>
<script src="//v2.libanswers.com/load_chat.php?hash=07713bc057f66ebcdccd4dd1b4a2be3e"></script>

1. Ensure that the "Customer Header" section matches the contents of html/header.html and the footer matches html/footer.html.

2. To make a change to the CSS stylesheet, navigate to src/css/styles.css in Github. Then click the edit icon and make your changes. Click the "Commit your changes" button.

3. Wait approximately 30 seconds to a minutes. Then reload the libapps page you're working on to see the result. You may have to clear your browser cache to see the change.

Technical Overview

This project uses Webpack to build assets and Amazon S3 (provided by UA CloudOps) to serve them. Github Actions are used to deploy to production on every commit/push to master (see .github/workflows/main.yaml for the full configuration). Two Github Secrets need to be present for the deployment to work: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. These should be set the values specified in Stache.

CORS

Since this project is providing assets that are supposed to be served on a domain other than the one they're hosted on, you have to ensure that your Cross-origin resource sharing (CORS) configuration for S3 allows this. The necessary setup is documented in cors.json. In the event that a new S3 bucket has to be provisioned to serve this project or the CORS configuration needs to be updated (e.g. to allow a new domain), you can set the CORS configuration using the following command:

aws s3api put-bucket-cors --profile <profile_name> --bucket <bucket_id> --cors-configuration file://cors.json