zooniverse / anti-slavery-manuscripts

Custom front end for a 2017 transcription project, annotating documents from the American abolitionist movement.
https://www.antislaverymanuscripts.org/
Apache License 2.0
3 stars 3 forks source link

Anti-Slavery Manuscripts

Anti-Slavery Manuscripts invites volunteers to transcribe documents from the American abolitionist movement, working together with the Zooniverse community and the Boston Public Library.

As of August 12, 2020, this project is complete. Transcribing and submitting classifications are disabled with PR 316 and a separate PR mentioned therein.

Usage

Install the dependencies:

npm install

Test:

npm run test

Development mode with live reload:

npm run start

When you are done, create a production-ready version of the JS bundle:

npm run build

Deployment

Deployment is handled by Github Action. Both staging and production deployment can be run ad hoc in the actions tab as needed if you have the appropriate permissions on the repository.

Staging

On merge to master, a Github Action is triggered to deploy to staging to https://antislaverymanuscripts.preview.zooniverse.org/.

Production

Production deployments are triggered by an update to which commit the production-release tag is pointed to. This tag should be updated via chat ops and then a Github Action will run that builds and uploads the files to our cloud provider found at https://www.antislaverymanuscripts.org/.

Credits

Based on the Zooniverse Redux starter template, which in turn was based on the original React Starterify (used under the MIT License).

License

Copyright 2015 Zooniverse

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.