A scalable and sharable storage system of literature annotation.
It is based on a production level DBMS, e.g., PostgreSQL, which makes it scaleable. Annotation data on PubAnnotation are shareable and comparable even if they come from different annotation projects.
Please use it with
- ruby version 2.3.4
- Postgresql 9.0 or above, and
- ElasticSearch 5 If your system does not already have an installation of ruby, you need to install it. Using rvm is generally a recommended way to install ruby in your system.
- git clone https://github.com/pubannotation/pubannotation.git
- cd pubannotation
- bundle install
- Edit config/database.yml as you like
- RAILE_ENV=production rake db:create
- RAILE_ENV=production rake db:migration
- RAILE_ENV=production rake assets:precompile
rails s -e production
(You will encounter an error message with an instruction to set a secret key for devise. Please follow the instruction.)
Google authentication procedure
Execute the following ur in the browser and log in with the pubannotation specific user account.
Create a pubannotation project. Example:
Click link(Enable APIs and services) to activate the API library:
OAuth consent screen.
Create authentication information(OAuth Client ID). Application type:
After creating an OAuth client, client id and client secret are generated:
Add an approved redirect URI.
[Same URL as environment variable(pubannotation)]/users/auth/google_oauth2/callback
Create .env file.
cp .env.example .env
.env file settings.
CLIENT_ID=[Generated client id] CLIENT_SECRET=[Generated client secret]