---

Checkboxer is a webtool built with STEM journal Editors in mind. Use Checkboxer to speed up submission requirement checks in pre-review.

1. Customise your modular revision template and checklist items in a CSV file
2. Complete the checklist per manuscript
3. Copy and paste the generated text to your email interface where you can personalise your message

Demo site

• https://checkboxer.fly.dev/ This is a live site deployed to Fly. It demonstrates checkboxer's functionality using placeholder text.

Why Checkboxer?

I've witnessed Journal Editors using paper checklists, struggling to copy and paste paragraphs from a large body of template text. Checkboxer remedies this system, generating only the text you need, every time.

• Checkboxer can save Editors minutes for every submission they check!
• Checkboxer lowers the chance of human errors, and makes editorial communication quality more consistent!

Submissions received in academic journals are checked for completeness before being sent to busy reviewers. The Journal Editor will perform the same check on every manuscript they receive, lifting standard text for each missing or incomplete item on their checklist, that gets sent to the author asking for their submission to be updated.

With checkboxer, Editors set up their checks and text only once. Each time they complete their checklist, the text to be sent to the Author will be automatically generated.

Installation and Set Up

First download the required gems with bundler:

$ bundle install

Then you'll need to install a webserver, I've used thin:

$ gem install thin

Important: You will need to customise your CSV file:

Running the app

Run your webserver then navigate to the localhost:XXportXX in your browser.

Eg using thin run the command in your terminal then go to localhost:3000:

$ thin start
Using rack adapter
Thin web server (v1.7.2 codename Bachmanity)
Maximum connections set to 1024
Listening on 0.0.0.0:3000, CTRL+C to stop

Running the tests

To run all feature and unit tests, use rspec in the command line from the project root:

$ rspec

Hello, world!
  index displays hello world

Finished in 0.01611 seconds (files took 0.42259 seconds to load)
1 example, 0 failures

To run code style tests, use rubocop in the command line from the project root:

$ rubocop
Inspecting 6 files
......

6 files inspected, no offenses detected

To run code quality tests, use rubycritic in the command line from the project root:

$ rubycritic
running flay smells

running flog smells
.......
running reek smells
.......
running complexity
.......
running attributes
.......
running churn
.......
New critique at file:XXX.html
Score: 96.28

Tech stack

• Capybara - an acceptance test framework for web applications
• CSS3 - a cascading style sheets language
• eRuby (embedded Ruby) - a templating system for embedding Ruby into a text document
• Heroku - a platform as a service
• HTML5 - an internet document mark-up language
• RSpec - a testing DSL for Ruby
• Rubocop - a static code analyzer and code formatter
• RubyCritic - a code quality analysis tool for Ruby
• Ruby - a dynamic, object oriented programming language
• SimpleCov - a code coverage analysis tool for Ruby
• Sinatra - a DSL for creating Ruby web applications
• Travis CI - a continuous integration platform and deployment manager

Wireframes

Resources

• wireframe.cc - a wireframe tool
• Learn how to create custom checkboxes and radio buttons with CSS.
• Icon made by Freepik from www.flaticon.com

License

Checkboxer is released under the MIT License.