Skip to content

Interactive commenting and community software with support for linked open data, translations, and external annotations

Notifications You must be signed in to change notification settings

CtrHellenicStudies/Commentary

Repository files navigation

GitHub tag GitHub license GitLab build GitLab coverage

Center for Hellenic Studies Classical Commentaries

The Center for Hellenic Studies (CHS) Classical Commentaries application is part of an ongoing effort of the CHS to create communities around texts. The application is used for creating multi-tenant, textual commentaries for classical texts as well as for creating annotations on the Center for Hellenic Studies website. It also offers a public community of users with some functionality similar to a social network.

The application supports three commentaries and two annotation platforms:

A Homer Commentary in Progress - Commentary on the works of Homer

A Pindar Commentary in Progress - Commentary on Pindar's Odes

A Pausanias Commentary in Progress - Commentary on the works of Pausanias (forthcoming)

The Center for Hellenic Studies Publications - Annotations on the CHS digital publications reading environment

Classical Inquiries - Annotations on the Classical Inquiries blog

The Center for Hellenic Studies Community - CHS Community Platform

Canonical Text Services URN Name Resolution Service - Resolving persistent identifiers such as created in the CITE architecture

GraphQL API to all commentaries and annotations with Linked Data support - All public data in the commentaries is surfaced through a GraphQL API endpoint with UI explorer

Development

The CHS Commentaries application frontend is created with the Create React App and has intentionally not deviated (e.g. ejecting webpack) for easy reuse by the community in the future. The backend for the application is a GraphQL API server built with express that you can find here: https://github.com/CtrHellenicStudies/CommentaryAPI

The Commentary GraphQL API relies on stitching the commentary GraphQL schema with The Center for Hellenic Studies Text Server with Canonical Text Service underpinnnings here: https://github.com/CtrHellenicStudies/Textserver

Getting started

To get started developing, you will need to clone the project and install Yarn. Then, install node dependencies with yarn. Next, edit your hosts file to add the chs.local subdomains:

127.0.0.1       chs.local
127.0.0.1       ahcip.chs.local
127.0.0.1       pindar.chs.local
127.0.0.1       pausanias.chs.local
127.0.0.1       profile.chs.local
127.0.0.1       api.chs.local
127.0.0.1       admin.chs.local
127.0.0.1       nrs.chs.local
127.0.0.1       classical-inquiries.chs.local
... etc

Finally, start the application with yarn start. The application should start on port 3000, and create an initial tenant for you so that you may view the application running at http://ahcip.chs.local:3000.

Branching methodology

The CHS Commentaries generally subscribes to the git-flow branching model when practical. The project does not use release branches but tags releases.

Deployment

Deployment is currently managed internally with the GitLab CI on the Archimedes GitLab instance, but you can follow one of several steps from the Create React App Documentation for Deployment.

We will update this section soon with more information about how to deploy your own commentary to as simple of hosting environment as GitHub pages. For now the Create React App documentation has this information.

Deployment of the CHS Commentaries platform frontend does not require advanced technical knowledge.

Contact

For more information about the project or how to use the CHS Commentaries to start your own commentary and community, please contact Leonard Muellner, Director of Publications and Information Technology at the CHS and Professor Emeritus of Classical Studies at Brandeis University.

Credits

The CHS Commentaries is project undertaken by the Center for Hellenic Studies and is directed by Leonard Muellner and advised by Philip Desenne.