Annotation Studio

An annotation platform designed for teaching and learning in the humanities, and with aspirations to more general use.

Works with: MIT Annotation Data Store

There are two servers required to run this application. This one, and the MIT Annotation Data Store. You MUST get the Annotation server running to be able to create or view annotations.

General Installation

Set up Rails (if you haven't yet, try: Thoughtbot's Laptop repo)

Do these first, regardless if you are installing locally or on Heroku:

git clone git@github.com:hyperstudio/Annotation-Studio.git annotation-studio
cd annotation-studio
bundle install
Copy config/application.sample.yml to config/application.yml Do not check this into git
Update config/application.yml with your configuration preferences: See file for in-line comments
Update the API_CONSUMER value in application.yml to point to the full URI of your running instance of MIT-Annotation-Data-Store

Localhost installation

These are rough instructions on how to get Annotation Studio working on your local development machine or server

Install and setup PostgreSQL-server (see Laptop repo above)
Create a PostgreSQL database
Copy config/database.sample.yml to config/database.yml Do not check this into git
Install Devise configuration for the current Devise version
rails g devise:install (yes to override as needed)
Add PostgreSQL connection URI into database.yml
rake db:migrate
rake db:seed
rails s

Installation on Heroku

If you would like to run the application on Heroku (recommended), do the following

Create a Heroku app heroku apps:create $APPNAME
Add the Heroku PostgreSQL add-on heroku addons:add heroku-postgresql
- Don't worry about providing db configuration, Heroku will do it for you
Use Figaro to load your application.yml into environment variables and communicate them to Heroku
- rake figaro:heroku[$APPNAME]

User Support and Developer forum

http://support.annotationstudio.org

Thanks

Thanks to:

NEH Office of Digital Humanities who has funded this project
OKFN for supporting The Annotator
Nick Stenning for being awesome and for leading the Annotator developer team
Dan Whaley, Randall Leeds and hypothes.is for being awesome and supporting the Annotator Community
The Annotator community for plugins and being awesome.

Contributors

Lab

MIT HyperStudio
http://hyperstudio.mit.edu/

Developers

Jamie Folsom @jamiefolsom
Liam Andrew @mailbackwards
Andrew Magliozzi @andrewmagliozzi
Daniel Collis-Puro @djcp
Seth Woodworth @sethwoodworth
Ayse Gursoy @gursoy
Jacob Hilker @jhilker

License

GPL2: http://www.gnu.org/licenses/gpl-2.0.html

FinalsClub/Annotation-Studio