{"id":16510715,"url":"https://github.com/wragge/realface-scribe","last_synced_at":"2026-05-13T03:10:18.024Z","repository":{"id":42614517,"uuid":"100561312","full_name":"wragge/realface-scribe","owner":"wragge","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-06T02:37:46.000Z","size":384882,"stargazers_count":0,"open_issues_count":6,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-02T07:44:40.020Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wragge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-17T04:26:38.000Z","updated_at":"2020-06-11T08:05:34.000Z","dependencies_parsed_at":"2023-01-19T08:15:35.275Z","dependency_job_id":null,"html_url":"https://github.com/wragge/realface-scribe","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wragge/realface-scribe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wragge%2Frealface-scribe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wragge%2Frealface-scribe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wragge%2Frealface-scribe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wragge%2Frealface-scribe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wragge","download_url":"https://codeload.github.com/wragge/realface-scribe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wragge%2Frealface-scribe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32965891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-12T23:30:32.555Z","status":"online","status_checked_at":"2026-05-13T02:00:07.132Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T15:56:30.453Z","updated_at":"2026-05-13T03:10:17.989Z","avatar_url":"https://github.com/wragge.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e This is a fork of ScribeAPI, updated in July 2017 to get it running on Heroku. See below for changes and additional documentation.\n\n\u003e **Warning**\n\u003e This project is experimental and not well supported.\n\n# Scribe \n\n[Scribe](http://scribeproject.github.io/) is a framework for crowdsourcing the transcription of text-based documents, particularly documents that are not well suited for Optical Character Recognition. It is a collaboration between [Zooniverse](https://www.zooniverse.org/) and [The New York Public Library Labs](http://labs.nypl.org/) with generous support from [The National Endowment for the Humanities (NEH), Office of Digital Humanities](http://www.neh.gov/divisions/odh).\n\n## For Project Creators\n\nAre you an organization or individual interested in using Scribe for your next crowdsourced transcription project? Start here!\n\n* What is Scribe and is it for me? Read our [Scribe Primer](https://github.com/zooniverse/scribeAPI/wiki/Getting-started)\n* Ready to set up your project? Head over to our [Project Setup page](https://github.com/zooniverse/scribeAPI/wiki/Setting-up-your-project)\n\n## For Contributors\n\nWould you like to contribute to the codebase? Check out these technical resources about the Scribe framework and make your first pull request!\n\n* [Terms and Keywords](https://github.com/zooniverse/scribeAPI/wiki/Terms-and-Keywords)\n* Setting up your environment on [Mac OSX](https://github.com/zooniverse/scribeAPI/wiki/Setup-Mac-OSX), [Windows](https://github.com/zooniverse/scribeAPI/wiki/Setup-in-Windows-Vagrant), or [Unix](https://github.com/zooniverse/scribeAPI/wiki/Setup-Unix)\n* [Data Model \u0026 Tools Config](https://github.com/zooniverse/scribeAPI/wiki/Data-Model-%26-Tools-Config)\n* [Creating Custom Marking Tools](https://github.com/zooniverse/scribeAPI/wiki/Creating-Custom-Marking-Tools)\n* [Setting up OAuth \u0026 Deploying](https://github.com/zooniverse/scribeAPI/wiki/Setting-up-OAuth-%26-Deploying)\n\n## Example Projects\n\nWe are launching Scribe with three very different projects by [Zooniverse](https://www.zooniverse.org/) and [The New York Public Library](http://www.nypl.org/):\n\n* [Emigrant City (NYPL)](http://emigrantcity.nypl.org)\n* [Measuring the Anzacs (Zooniverse)](http://measuringtheanzacs.org)\n* [Old Weather: Whaling (Zooniverse)](http://whaling.oldweather.org)\n\n## Changes to get running on Heroku (July 2017)\n\n### Software versions\n\n* There seem to be compatibility problems with Node versions greater than 6. I edited `package.json` to pin Node at 6.11.1, as recommended by the [Heroku documentation](https://devcenter.heroku.com/articles/nodejs-support). You might need to [use n](https://github.com/tj/n) to install and activate a specific version of Node for development.\n\n* Heroku [no longer supports](https://devcenter.heroku.com/articles/ruby-support) 2.1.* versions of Ruby. I changed Gemfile to specify `ruby '2.2.7'`, which is the earliest supported version. I also changed `.ruby-version` accordingly.\n\n* MLab databases now use MongoDB 3, but Mongoid 4 doesn't seem able to authenticate with MongoDB 3 urls. So I changed the `Gemfile` and `Gemfile.lock` to set Mongoid at 5.2.1.\n\n* The mongoid change also meant I had to update `mongoid-rspec`, `rspec-rails`, `bson`, and `origin`. I also removed the `bson` requirement from `moped`.\n\n### Code changes\n\n* In `config/mongoid.yml` changed `sessions` to `clients`.\n* In `app/models/classification.rb` changed `find_and_modify` mthod to `find_one_and_update`.\n\n### Environment variables -- Development\n\nThis isn't really mentioned in the [ScribeAPI wiki](https://github.com/zooniverse/scribeAPI/wiki):\n\n* Create a file in the root of the project called `.env`.\n* Use `rake secret` to create a secret key.\n* Add `DEVISE_SECRET_TOKEN=yournewkey` to `.env`.\n* Repeat to add `SECRET_KEY_BASE_TOKEN=anothernewkey` to `.env`.\n* To specify the name of the Mongo database you want to create, set `MONGO_DB=yourdbname`\n* If you're going to start up the Puma web server (see below), add `RACK_ENV=development` and `PORT=3000`\n\nAlso add your OAUTH keys to `.env` as mentioned [in the wiki](https://github.com/zooniverse/scribeAPI/wiki/Setting-up-OAuth-%26-Deploying).\n\n### Deployment to Heroku\n\nAfter creating your Heroku app and database as described [in the wiki](https://github.com/zooniverse/scribeAPI/wiki/Setting-up-OAuth-%26-Deploying):\n\n* Add `DEVISE_SECRET_TOKEN` and `SECRET_KEY_BASE_TOKEN` to Heroku's environment variables, eg: `heroku config:set \"DEVISE_SECRET_TOKEN=yournewkey\"`\n* Add your `MONGOLAB_URI` and OAUTH credentials as described in the wiki.\n\nThe information about buildpacks in the wiki is out of date. Ignore the section about `BUILDPACK_URL` but before you deploy to Heroku run the following commands:\n\n* `heroku buildpacks:add --index 1 heroku/nodejs`\n* `heroku buildpacks:add --index 2 heroku/ruby`\n\nThe index values are important as Node needs to be built first, otherwise the Ruby build will fail complaining about Browserify.\n\n### Procfile\n\nThe original repo had a non-functional `procfile` -- capitalisation matters to Heroku, so I've renamed it `Procfile`. Heroku recommends running the [Puma web server](https://devcenter.heroku.com/articles/getting-started-with-rails4#webserver), so I've just followed their instructions on what to include in the `Procfile`. If you want to test the config in your development environment, make sure you set the `RACK_ENV` and `PORT` values in your `.env` file and then use Foreman -- `foreman start`.\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwragge%2Frealface-scribe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwragge%2Frealface-scribe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwragge%2Frealface-scribe/lists"}