An end-user environment for working with data in the CITE environment—browsing and analyzing texts, viewing objects and images, visualizing graphs of scholarly data. Written in ScalaJS.
JavaScript HTML Scala Other
Switch branches/tags
Nothing to show
Clone or download

README.md

CiteApp 1.12.0 Scala 2.12.3 ScalaJS 0.6.22 xCite 3.3.0 OHCO2 10.8.1 SCM 6.1.0 CiteObj 7.0.1 CiteRelations 2.2.0 CiteBinaryImage 1.1.2 Harvard CHS, Cite Architecture Furman Classics Holy Cross Classics

CITE Application

A single-page browser application for exploring citable resources, written in Scala.js.

Current version: 1.12.0

See release notes.

License

GPL 3.0

CITE Application, by default, downloads a sample corpus of texts. Licensing and attribution for those texts is available in the downloads directory.

Using

CITE Application is a single web page you can open in a browser. Precompiled versions are available in the downloads directory, and named cite-VERSION.html.

N.b. In the downloads directory there is a js directory that CiteApp uses for providing zooming views of binary images, using OpenSeadragon.

Images not working? You probably need to deal with browser restrictions. See the Wiki page on this topic.

Building

CITE Application is targetted for Scala 2.12.You can use normal sbt using normal tasks for ScalaJS projects such as sbt fastOptJS or sbt fullOptJS.

If sbt fastOptJS completes successfully, run the app by opening CITE-App/target/scala-2.12/classes/index-dev.html in your browser.

If sbt fullOptJS completes successfully, run the app by opening CITE-App/target/scala-2.12/classes/index-opt.html in your browser.

In addition, the project defines a custom spa task that builds a single-page application named cite-VERSION.html (where VERSION is the current version defined in build.sbt), in the downloads directory.

If sbt fastOptJS completes successfully, run the app by opening CITE-App/target/scala-2.12/classes/index-dev.html in your browser.

If sbt fullOptJS completes successfully, run the app by opening CITE-App/target/scala-2.12/classes/index-opt.html in your browser.

Images for CiteApp

Documentation for configuring collections of images for CiteApp is underway at https://github.com/cite-architecture/CITE-image-configurations.

The downloads/image_archive directory contains a one-image sample setup showing how to implement URN-aware DeepZoom images.

Python SimpleServer

Running CiteApp locally, and attempting to access images, can run afoul of the Cross-Origin-Restrictions (CORS). It may be possible to tell your browser to ignore that security precaution. Or, a safer alternative, is to serve CiteApp locally. If Python is installed, navigate to the directory that contains cite-VERSION.html, and execute:

python -m SimpleHTTPServer

Credits

CITEApplication, © 2017, 2018: Neel Smith and Christopher Blackwell. Available for use, modification, and distribution under the terms of the GPL 3.0 license. Based on the CITE and CTS protocols, by Neel Smith and Christopher Blackwell.