A platform for managing the submission and review of research outputs
Switch branches/tags
APERTA-8655-html-column-refactor APERTA-8858-message-for-failed-ihat-conversions APERTA-10414-prevent-deletion-of-front-matter-reviewer-report APERTA-10439-preprint-decision-scenario APERTA-11067-permissions-for-admin-ui APERTA-11209-speed-up-xml-save APERTA-11209-traverse-card-contents APERTA-11758-no-inputs-in-if-isEditable APERTA-12565-workflow-cards-CSS bug/APERTA-7041-single-quote-error bug/APERTA-10091-corrupt-manuscript bug/APERTA-10847-Custom-Card-numbered-lists-Numbers-are-bottom-aligned-on-Side-Bar bug/APERTA-11053-xml-error bug/APERTA-11195-Inconsistent-Custom-Card-Form-Element-Spacing bug/APERTA-11299-fix-competing-interest-card bugs/APERTA-9619-fix-cancel-button-on-adhoc-card-title-PO bugs/APERTA-10092-fix-additional-information bugs/APERTA-10951-dependent-card-permissions-in-ui-2 bugs/APERTA-10951-dependent-card-permissions-in-ui-erik bugs/APERTA-11833-validation-error-class-on-card-button bugs/APERTA-11875-add-default-for-preprint-opt-out-method bugs/APERTA-12003-fix-pdf-viewer-refresh bugs/11291-tinymce-not-loading_async-approach chore/APERTA-9889-associate-card-to-answerable-merged chore/APERTA-9889-participants-fix chore/APERTA-11062 chore/circleci-2 chore/migrate-legacy-tasks-to-cards chores/decrease-unnecessary-rspec-models circlecis-playground csv debt/APERTA-12034-eliminate-old-modules debt/APERTA-12034-move-to-rails develop empowerment/cache-can empowerment/card-content-serialization empowerment/prevent-country-crash empowerment/try-circle-config empowerment/update-pairs feature/APERTA-7236-remove-striking-checkboxes feature/APERTA-9677-enhance-correspondence-history feature/APERTA-9936-required-for-submission-workflow-only-not-both feature/APERTA-10148-move-billing-file-transfer-earlier feature/APERTA-10188-add-repeater-card-component feature/APERTA-11700-reviewer-query features/APERTA-8421-upgrade-circle-ci features/APERTA-9047-external-correspondence-history features/APERTA-9724-mailer-card-content features/APERTA-9733-Mark-field-as-required features/APERTA-9958-disable-auto-sim-check-for-manual-report-chris features/APERTA-9958-disable-auto-sim-check-for-manual-report-merge-test features/APERTA-9958-disable-auto-sim-check-for-manual-report-r1 features/APERTA-10022-simplify-xml features/APERTA-10097-convert-competing-interest-card-to-card-config-old features/APERTA-10097-convert-competing-interest-card-to-card-config-part-deux features/APERTA-10170-convert-paragaph-to-tiny-mce features/APERTA-10175-sendback-component-cw features/APERTA-10175-sendback-component features/APERTA-10253-preprint-assign-doi-on-export features/APERTA-10322-adapt-new-reviewer-invitation-flow-to-academic-editors features/APERTA-10339-Validations-get-triggered-and-enforced-on-card-completion features/APERTA-10362-sendback-preview-test features/APERTA-10370-enforce-manuscript-email-uniqueness features/APERTA-10422-Boolean-radio-button-content-type features/APERTA-10441-store-paper-tracker-query-sort-params-rb features/APERTA-10452-migrate-cover-letter-to-card-config features/APERTA-10502-create-changes-for-author-on-sendback features/APERTA-10763-migrate-legacy-cover-letter-to-custom-card-part-deux features/APERTA-10900-wip-planning-cw features/APERTA-10900-wip-planning features/APERTA-11067-limit-cards-visibility features/APERTA-11196-ember-decline-flow features/APERTA-11218-upgrade-ember-to-2.15 features/APERTA-11269-update-inputs-on-change features/APERTA-11978-liquid-template-card-content-2 features/APERTA-11978-liquid-template-card-content-3 features/APERTA-11978-liquid-template-card-content features/APERTA-12300-allow-minor-check-from-initially-submitted features/APERTA-12445-relax-view-footer-perms features/APERTA-12568-database-initialization features/NAC-251-orcid-sso-pilot fix/APERTA-8610-group-author-support fix/APERTA-9709-stop-answer-jank fix/APERTA-12098 fix/APERTA-12832 hotfix/APERTA-10092-fix-additional-information html-sanitization-migrate-check master origin/feature/APERTA-9936-required-for-submission-workflow-only-not-both origin/feature/APERTA-10015-step1c-split-html oss-security-audit release/1.60 release/1.62 rename_versioned_text revert-3337-feature/APERTA-10111-Create-EM-export-card-using-Export-component spike/APERTA-10385-paper-tracker-performance spike/APERTA-10397-migrate-mansucript-card spike/custom-card-rendering spikes/APERTA-10022 upgrade-ember-to-2.15 zom-chores/APERTA-12351-remove-orcid-signup
Nothing to show
Clone or download
Jeffrey Gray
Jeffrey Gray Merge pull request #4096 from Aperta-project/releng-weekly-build
Implemented workflow with two named workflows: build_includes_test an…
Latest commit 44d7ca4 Aug 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Implemented workflow with two named workflows: build_includes_test an… Aug 10, 2018
.fonts APERTA-5889 Add default MathJax fonts Jan 26, 2016
app Merge branch 'develop' into empowerment/clean-up-config Jul 20, 2018
bin APERTA-12826 New circle 2 config May 17, 2018
client APERTA-12977 Update PACE link Jul 11, 2018
config
db
lib
log
public
spec Merge branch 'develop' into empowerment/clean-up-config Jul 20, 2018
vendor/assets Remove old, unused file Apr 13, 2018
xml APERTA-12782 Add copyright headers and license to html, xml, yml Apr 13, 2018
.agignore update agignore Oct 31, 2016
.buildpacks APERTA-9644 attempt to add qpdf buildpack for heroku Jun 2, 2017
.codeclimate.yml APERTA-12782 Add copyright headers and license to html, xml, yml Apr 13, 2018
.editorconfig
.env Cas logout url default value should include host and port May 18, 2018
.env.test use env vars for specs Dec 14, 2017
.eslintignore Use eslint Jun 23, 2016
.eslintrc.json APERTA-10567 relax lint rules Aug 10, 2017
.gitignore Merge Master Nov 15, 2017
.ignore Add .ignore file Aug 14, 2017
.node-version Upgrade to node 6.11.1 Jul 26, 2017
.nvmrc
.overcommit.yml APERTA-12782 Add copyright headers and license to html, xml, yml Apr 13, 2018
.rubocop.yml
.ruby-gemset Initial import of rails app with rspec and devise views Oct 28, 2013
.ruby-version Upgrade to ruby 2.3.6 Dec 15, 2017
.slugignore Add osx bin to slugignore May 12, 2017
CHANGELOG.md APERTA-12740 Restart changelog Mar 29, 2018
CODE_OF_CONDUCT.md Update email address in code of conduct Apr 24, 2018
Capfile APERTA-12782 Add copyright headers and license to all source files Apr 13, 2018
Gemfile APERTA-12826 Drop rspec retry May 17, 2018
Gemfile.lock APERTA-12976 Upgrade sprockets Jun 26, 2018
LICENSE.txt Update (c) date. Remove useless line. Apr 17, 2018
PULL_REQUEST_TEMPLATE.md Merge pull request #4029 from Aperta-project/task/APERTA-12744-remove… Apr 3, 2018
Procfile Migrate the heroku database upon each release Mar 29, 2017
Procfile.template Get rid of unnecessary RAILS_ENV in procfile Aug 17, 2016
README.md
Rakefile APERTA-12782 Add copyright headers and license to all source files Apr 13, 2018
STIX Font License 2010.pdf
app.json
config.ru APERTA-12782 Add copyright headers and license to all source files Apr 13, 2018
package.json Replace Tahi-project/tahi with Aperta-project/aperta Mar 26, 2018
yarn.lock APERTA-10265 add yarn.lock to project root to trick heroku Aug 4, 2017

README.md

Aperta

CircleCI

Aperta is a platform for managing the submission and review of research outputs.

Initial Setup

Overview

Aperta is supported on Linux and Mac. Our bin/setup script should work on Macs, Debian and Ubuntu.

  1. Ensure you have Ruby 2.3.6 installed. We recommend using rbenv or rvm to manage your ruby versions. Aperta will probably work on other Ruby versions, but we only provide support for 2.3.6.
  2. Have a keypair for AWS account with permissions to create new IAM users and S3 buckets available.
  3. Run the setup script (bin/setup)
  4. Run foreman start
  5. Visit http://localhost:5000/ in your browser and login using the username author or editor and the password password.

Detailed steps

Install ruby

We recommend using a ruby version manager, e.g. rvm or rbenv. Either one should meet your needs. Installing them is outside the scope of this README. Please refer to the installation instructions in those project.

Set up AWS

The bin/setup script will prompt you for an AWS key/secret key pair. This should be a key pair attached to a user that can create a new S3 bucket and IAM user and set up access. The simplest thing would be to attach it to a root user. The steps are beyond this README, but you can get started here

Automated Setup

  • Run:
./bin/setup

Running this script will:

  • Install dependencies
  • Create the following config files:
    • .env.development
    • .foreman
    • Procfile.local
    • config/database.yml
  • Create a new database
  • Create a new AWS IAM user and S3 bucket and configure them.

Run the server

Run foreman start to start the web server, worker, and slanger.

Login

Aperta should be listening on http://localhost:5000 You can login using the password password as a number of pre-configured users with the following user names:

  • academic_editor
  • admin
  • author
  • billing
  • collaborator
  • cover_editor
  • discussion_participant
  • editor
  • freelancer
  • handling_editor
  • journal_setup_admin
  • participant
  • production_staff
  • publishing_services
  • reviewer
  • site_admin
  • staff_admin

More information

For more information for developers, please visit the wiki

Troubleshooting

  1. Make sure the following servers are already running and listening on the correct ports:
    • PostgreSQL (5432)
    • Redis (6379)
  2. Make sure the following ports are open:
    • 4567 (Slanger API)
    • 40604 (Slanger websocket)
    • 5000 (Rails server)

Note that the bin/setup can be run as many times as you like as you correct issues that it runs into.

Running the test suite

Aperta uses rspec for ruby testing and qunit for javascript testing. To run the rspec tests, use bundle exec rspec. To run the qunit test, use bundle exec rake ember:test.

To run the capybara feature specs, you will need to have a recent version of firefox and geckodriver in your $PATH.