Adding New Custom Images to ScribeAPI (Incomplete)

The task at hand involved adding new/custom images to the Scribe Web Application. Sample files are in /home/ubuntu/test-images/ in UCLA Library EC2 server.

To run the Emigrant City project by NYPL out of the box there are 3 commands.

  $ mongod
  $ rake project:load['CC-ing']
  $ rails server

When we run the "rake" command we get to see all of the components that comprise Emigrant City being uploaded.

Sample output of the "rake" command is as follows:

Init: OAUTH providers: []
Routing static assets from ./project/cc-ing/assets
Created project: Community Cataloging
Loading pages from /Users/jeffreyqiu/Desktop/BuildUCLA/CC-ing/scribeAPI/project/CC-ing/content:
  Loading page: "About" (4546b)
  Loading page: "Data" (494b)
  Loading page: "Home" (370b)
  Loading page: "Intro" (2439b)
  Loading partial: "footer" (213b)
Tutorial: Loading workflows from /Users/jeffreyqiu/Desktop/BuildUCLA/CC-ing/scribeAPI/project/CC-ing/tutorial/*.json
    Loaded help file: learn_marking
    Loaded help file: learn_transcribing
    Loaded help file: learn_verifying
    Loaded help file: tutorial_mark_1
    Loaded help file: tutorial_mark_2
    Loaded help file: tutorial_mark_3
    Loaded help file: tutorial_mark_4
    Loaded help file: tutorial_mark_5
    Loaded help file: tutorial_transcribe_1
    Loaded help file: tutorial_verify_1
Done loading content for "Community Cataloging"
Loading fonts from /Users/jeffreyqiu/Desktop/BuildUCLA/CC-ing/scribeAPI/project/CC-ing/fonts/:
Done loading style for "Community Cataloging"
Workflows: Loading workflows from /Users/jeffreyqiu/Desktop/BuildUCLA/CC-ing/scribeAPI/project/CC-    ing/workflows/*.json
  Loading 'mark' workflow
    Loaded help file: mark_primary
    Loaded help file: m_record_date
    Loaded help file: m_record_number
    Loaded help file: m_record_mortgager
    Loaded help file: m_record_street_address
    Loaded 2 task(s)
  Loading 'transcribe' workflow
    Loaded help file: t_record_date
    Loaded help file: t_record_number
    Loaded help file: t_record_mortgager
    Loaded help file: t_record_street_address
    Loaded help file: t_record_amount_loaned
    Loaded help file: t_record_valuation
    Loaded help file: t_record_valuation
    Loaded help file: t_record_valuation
    Loaded help file: t_survey
    Loaded help file: t_record_survey_stories_materials
    Loaded help file: t_record_additional_info
    Loaded 11 task(s)
  Loading 'verify' workflow
    Loaded help file: v_date
    Loaded help file: v_text
    Loaded help file: v_text
    Loaded help file: v_text
    Loaded help file: v_currency
    Loaded help file: v_date
    Loaded help file: v_currency
    Loaded help file: v_currency
    Loaded help file: v_text
    Loaded help file: v_text
    Loaded 10 task(s)
Done loading 3 workflow(s) into "Community Cataloging"
Groups: Creating 1 groups from groups.csv
  Creating group 1 of 1: only_one_group
    Reading subjects from: /Users/jeffreyqiu/Desktop/BuildUCLA/CC-ing/scribeAPI/project/CC-ing/subjects/group_only_one_group.csv
    Adding subject set: _autogen_set_key_2
      - saved subject set https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/thumb/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.left-top.jpg
Added subject: https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/full/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.left-top.jpg
    Adding subject set: _autogen_set_key_3
      - saved subject set https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/thumb/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.left-bottom.jpg
Added subject: https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/full/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.left-bottom.jpg
    Adding subject set: _autogen_set_key_4
      - saved subject set https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/thumb/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.right-top.jpg
Added subject: https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/full/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.right-top.jpg
    Adding subject set: _autogen_set_key_5
      - saved subject set https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/thumb/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.right-bottom.jpg
Added subject: https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/full/e38ae1d0-00b1-0133-2ced-58d385a7bbd0.right-bottom.jpg
    Adding subject set: _autogen_set_key_6
      - saved subject set https://s3.amazonaws.com/scribe.nypl.org/emigrant-s4/thumb/e394a0c0-00b1-0133-224a-58d385a7bbd0.left-top.jpg

[output truncated]

The first thing that "rake" does is upload the static html pages that are located in the "./project/cc-ing/assets" folder. It then loads the (3) workflows defined by our .json files located in the "/scribeAPI/project/CC-ing/tutorial" folder to build the tutorial that each user encounters at start up.

Following the loading of the tutorial "/scribeAPI/project/CC-ing/workflows" the workflows defining the actual meat of the Emigrant City project (that is, the "Mark", "Transcribe", and "Verify" workflows) are loaded.

More info regarding project workflows can be found in the wiki: https://github.com/zooniverse/scribeAPI/wiki/Project-Workflows

A "group" of subjects is then created by the key defined by the "groups.csv" file.

As an aside, a "subject" is defined as a "uniquely identifiable media document, usually containing an image, that users are asked to work on". AKA (in our case) an image.

All of the subjects are then read from the "scribeAPI/project/CC-ing/subjects/group_only_one_group.csv" file. We can populate the "group_only_one_group.csv" file with our custom image URLs in the first column that defines the image URL endpoint for our API/Web Form controllers.