Skip to content

rootsdev/scribeAPI

 
 

Repository files navigation

Scribe API

Scribe is a framework for crowdsourcing the transcription of text-based documents, particularly documents that are not well suited for Optical Character Recognition.

Check out the documentation and the wiki for further resources.

Quick Start

Copy example project folder: `cp -R project/example_project project/%PROJECT_KEY%`

Edit your project files - in particular:

  • Project properties (project.rb)
  • Workflows (workflows/*.json )
  • Groups and subjects (subjects/groups.csv, each 'name' of which refers to subjects/group_%NAME%.csv)
  • Pages (content/*.html.erb)

Build project: rake project_load[%PROJECT_KEY%]

Deploying To Heroku

Since we're running a node front-end within a rails app, we need a custom buildback https://github.com/ddollar/heroku-buildpack-multi

$ heroku config:add BUILDPACK_URL=https://github.com/ddollar/heroku-buildpack-multi.git

Then, set up a heroku remote and deploy to it.

$ heroku git:remote -a HEROKU_APP_NAME
$ git add .
$ git commit -am "make it better"
$ git push heroku master

Make sure you have a MongoDB instance running, e.g. by adding MongoLab to your Heroku app, before loading the project with the provided rake task: $ heroku run rake project_load[%PROJECT_KEY%]

Tests

`npm test` to run the Jest test suite

Background

This application was generated with the rails_apps_composer gem: https://github.com/RailsApps/rails_apps_composer provided by the RailsApps Project: http://railsapps.github.io/

Recipes: ["apps4", "controllers", "core", "email", "extras", "frontend", "gems", "git", "init", "models", "prelaunch", "railsapps", "readme", "routes", "saas", "setup", "testing", "views"]

Preferences: {:git=>true, :apps4=>"none", :dev_webserver=>"webrick", :prod_webserver=>"same", :database=>"mongodb", :orm=>"mongoid", :templates=>"erb", :unit_test=>"rspec", :integration=>"cucumber", :continuous_testing=>"none", :fixtures=>"none", :frontend=>"none", :email=>"gmail", :authentication=>"devise", :devise_modules=>"default", :authorization=>"none", :form_builder=>"none", :starter_app=>"users_app", :rvmrc=>false, :quiet_assets=>true, :better_errors=>true}

About

scribe API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • CoffeeScript 37.4%
  • Ruby 34.4%
  • HTML 16.5%
  • CSS 10.9%
  • Gherkin 0.4%
  • Python 0.3%
  • Other 0.1%