Zooniverse Community Catalog

Welcome to the Community Catalog, a Zooniverse-powered website for exploring community-tagged images.

Users: you can view the website at https://community-catalog.zooniverse.org/

Developers:

• Please see the source code documentation in /src
• If you want to add/modify Zooniverse projects to/in the Catalog, check the Operations section below.
• If you want to modify other config settings, please see src/config.js

Operations

How to add more Projects to, or modify Projects in, the Catalog

1. Make changes to the Projects config list, i.e. src/projects.json
2. If necessary, make equivalent changes in the Projects config list of subject-set-search-api

Of course, you'll need to deploy community-catalog (and subject-set-search-api) once you've made those changes.

How to update Projects

This is usually only required when a project owner adds new Subjects to a project. Note that if the database's (i.e. Subject Set Search API's) code was recently deployed, then by definition the database has already been updated.

1. On Slack, ask Lita to rebuild the database
2. The command is usually something like lita rebuild subject set search API

If that fails (e.g. Lita is down), then just trigger a deploy for the Subject Set Search API

How to tell if the Catalog is working

You want to use the Community Catalog Stable Test Project (CCSTP) to test basic functionality.

Community Catalog Stable Test Project:

• A Zooniverse project set up so the Community Catalog has a baseline of data/content to pull from, to demonstrate functionality.
• We've learnt from previous experience that, if our apps/features only target their intended launch project, then we can never figure out if those apps/features are still working when the project gets retired/modified/etc.
• The CCSTP has 10 Subjects with simple metadata (matching the intended launch project) and several Subjects have hashtags on their Talk discussions. (example)
• Zooniverse URL
• Community Catalog URL

Standard Testing Steps:

• Open the landing page (production / local)
  • Note that the ?env=production is essential for local development
  • You should see at least one project listed on the page.
  • The CCTP shouldn't be listed, as it has hidden=true set in the Projects config list.
• Open the Community Catalog Stable Test Project project page (production / local)
  • You should see 3 example Subjects in the highlights, 10 keywords in the keywords list, and at least 4 Subjects under the 'search results for "devtest"'
  • Every Subject should display a proper photo (i.e. not a placeholder icon)
• Click on any photo to view that Subject on the subject page (production example / local example)
  • You should see the title, e.g. 'Medical|Nurses - Foreign, "Coloured", etc.'
  • You should see a photo for the Subject, e.g. a nurse
  • Each Subject should have two photos, which you can navigate between by clicking on the filmstrip.
  • You should see some Talk posts pulled from the Subject Discussion, e.g. Shaun A. Noordin saying "#Jamaica #Fulham #Hospital #DevTest"
  • You should see insitutional metadata listed out, e.g. "item: photograph / notes: (nothing) / folder: Medical|Nurses - Foreign, "Coloured", etc. / image1: SMG00444177_0001.jpg / image2: SMG00444177_0002.jpg / etc etc"
  • You should see user-generated community tags, e.g. #Jamaica #Fulham #Hospital #DevTest (corresponding with the Subject Discussion)
  • You should be able to click on "View this Subject Discussion on Talk" to go to Talk (example)
  • You should be able to click on "Classify this Subject" to classify that specific Subject on FEM's Classifier (example)
  • You should be able to see a random assortment of 10 Subjects under "Continue exploring"
• Type in some text, e.g. "Jamaica", into searchbar in the header then press Enter on the keyboard to view the search results page (projection example / local example)
  • You should see Subjects listed in the search results list, if there are any. (For "Jamaica", you should see at least 4 Subjects)

Advanced Testing Steps:

• Feature: Sensitive Image Warning
  • Some Subjects contain sensitive content. For example, Subject 87892461. For these Subjects, we want to hide the sensitive content behind a simple warning, that users have to opt-in into if they wish to view it.
  • Open Subject 87892461's subject page.
  • The photo should be blurred, and a "This image may contain sensitive content" warning should be overlaid on top of the photo.
  • Clicking on the "show sensitive images" button should now fully display the photo.
  • Now search for the term "Coloured" to see the search results page
  • Subject 87892461 should be listed in the results, and its photo should be blurred out with a similar warning.
  • Clicking on the "show sensitive images" button should once again fully display the photo.

FYI, the Community Catalog's intended launch project is "How Did We Get Here?", and it served as the template for initial development.

• Zooniverse URL
• Community Catalog URL

Development

This project is a React website that connects to various Zooniverse databases/services.

Requires:

• node 20 and npm 10

External requirements:

• zooniverse.org: required for user auth.
• talk.zooniverse.org: required for Talk keyword (aka tags/hashtags) searches.
• subject-set-search-api.zooniverse.org: required for database searches.

How to run the website on your computer:

• Add local.zooniverse.org as an alias for localhost to your hosts file.
• Run npm install (or npm ci) to install dependencies.
• Run npm start to start the local dev server.
• Open https://local.zooniverse.org:8080?env=production in your browser to view the website.
  • Please be sure to set the environment to production, as even local development requires access to production data.
• Optionally,

How to deploy the website to community-catalog.zooniverse.org:

• Deploys are performed via GitHub actions.
  • Option 1: Check the #deploys channel on our Zooniverse Slack for the necessary chat commands.
  • Option 2: manually update the production-release tag to the latest commit in this repo (or the commit you wish to deploy).
• Monitor progress on the GitHub Actions tab of this repo.

How to update the indexed Subjects database:

• The database needs to be manually updated whenever the projects add new Subjects.
• There should be a lita command on the Zooniverse Slack that automates this.
• See subject-set-search-api for additional details.

Developer Notes

Scope & Lifespan @shaunanoordin 2022.12.13:

• community-catalog is meant to be a "fast development" custom front end, with a specific experimental goal and a limited lifespan.
• Starting code was based off a very stripped down version of create-react-app v5 and Front-End-Monorepo. Dependencies are kept at a minimum to make maintenance easier.
• This repo should be archived after (TODO: INSERT INITIAL LIFESPAN DATE HERE).

Auth & Login @shaunanoordin 2023.01.05

• Unlike many of our earlier CFEs (custom front ends), the Community Catalog doesn't use oauth from panoptes-client for logins.
• Instead, the CC relies on the trust afforded across the entire Zooniverse domain. If you're on any *.zooniverse.org site, you're also logged in to community-catalog.zooniverse.org
• This reason (along with other CORS-related API calls) is why, when testing/developing on local, you need to have local.zooniverse.org:8080 set up.