{"id":16946866,"url":"https://github.com/ruthmoog/checkboxer","last_synced_at":"2025-06-14T02:33:12.168Z","repository":{"id":39695335,"uuid":"199308487","full_name":"ruthmoog/checkboxer","owner":"ruthmoog","description":"✅ Generate custom revision templates for academic journals","archived":false,"fork":false,"pushed_at":"2024-02-29T01:03:39.000Z","size":475,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-26T05:42:43.271Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://checkboxer.fly.dev/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruthmoog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-28T16:03:11.000Z","updated_at":"2023-09-01T07:20:09.000Z","dependencies_parsed_at":"2023-02-10T18:00:38.250Z","dependency_job_id":null,"html_url":"https://github.com/ruthmoog/checkboxer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruthmoog%2Fcheckboxer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruthmoog%2Fcheckboxer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruthmoog%2Fcheckboxer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruthmoog%2Fcheckboxer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruthmoog","download_url":"https://codeload.github.com/ruthmoog/checkboxer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244767801,"owners_count":20507110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T21:44:58.732Z","updated_at":"2025-03-21T09:17:06.354Z","avatar_url":"https://github.com/ruthmoog.png","language":"Ruby","readme":"![Checkboxer](./public/images/header.png)\n\n-----\n\n\n[![Demo website status](https://img.shields.io/website?down_color=lightgrey\u0026down_message=offline\u0026label=demo\u0026style=for-the-badge\u0026up_color=hotpink\u0026up_message=online\u0026url=https%3A%2F%2Fcheckboxer.fly.dev%2F)](https://checkboxer.fly.dev/)\n\nCheckbo**x**er is a webtool built with STEM journal Editors in mind.  Use Checkbo**x**er to speed up submission requirement checks in pre-review.\n1. Customise your modular revision template and checklist items in a CSV file\n2. Complete the checklist per manuscript\n3. Copy and paste the generated text to your email interface where you can personalise your message\n\n![Checkboxer project](https://github.com/ruthmoog/portfolio/blob/master/public/images/projects/checkboxer.webp)\n\n## Demo site\n- https://checkboxer.fly.dev/\nThis is a live site deployed to Fly.  It demonstrates checkbo**x**er's functionality using placeholder text.\n\n### Why Checkbo**x**er?\n\nI've witnessed Journal Editors using paper checklists, struggling to copy and paste paragraphs from a large body of template text.  Checkbo**x**er remedies this system, generating only the text you need, every time.\n\n- Checkbo**x**er can save Editors _minutes_ for every submission they check!\n- Checkbo**x**er lowers the chance of human errors, and makes editorial communication quality more consistent!\n\nSubmissions 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.\n\nWith 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.\n\n## Installation and Set Up\n\nFirst download the required gems with bundler:\n```console\n$ bundle install\n```\n\nThen you'll need to install a webserver, I've used `thin`:\n```console\n$ gem install thin\n```\n\n**Important**: You will need to customise your CSV file:\n![CSV guidelines](./public/images/csv_guidance.png)\n\n## Running the app\n\nRun your webserver then navigate to the `localhost:XXportXX` in your browser.\n\nEg using `thin` run the command in your terminal then go to `localhost:3000`:\n```console\n$ thin start\nUsing rack adapter\nThin web server (v1.7.2 codename Bachmanity)\nMaximum connections set to 1024\nListening on 0.0.0.0:3000, CTRL+C to stop\n```\n\n## Running the tests\n\nTo run all feature and unit tests, use `rspec` in the command line from the project root:\n```console\n$ rspec\n\nHello, world!\n  index displays hello world\n\nFinished in 0.01611 seconds (files took 0.42259 seconds to load)\n1 example, 0 failures\n```\n\nTo run code style tests, use `rubocop` in the command line from the project root:\n```console\n$ rubocop\nInspecting 6 files\n......\n\n6 files inspected, no offenses detected\n```\n\nTo run code quality tests, use `rubycritic` in the command line from the project root:\n```console\n$ rubycritic\nrunning flay smells\n\nrunning flog smells\n.......\nrunning reek smells\n.......\nrunning complexity\n.......\nrunning attributes\n.......\nrunning churn\n.......\nNew critique at file:XXX.html\nScore: 96.28\n```\n\n![lighthouse audit](./public/images/lighthouse.png)\n\n## Tech stack\n\n- [Capybara](https://github.com/teamcapybara/capybara) - an acceptance test framework for web applications\n- [CSS3](https://developer.mozilla.org/en-US/docs/Archive/CSS3) - a cascading style sheets language\n- [eRuby](https://ruby-doc.org/stdlib-2.6.3/libdoc/erb/rdoc/ERB.html) (embedded Ruby) - a templating system for embedding Ruby into a text document\n- [Heroku](https://www.heroku.com/) - a _platform as a service_\n- [HTML5](https://w3.org/html/logo) - an internet document mark-up language\n- [RSpec](https://rspec.info/) - a testing DSL for Ruby\n- [Rubocop](https://rubocop.readthedocs.io/en/stable/) - a static code analyzer and code formatter\n- [RubyCritic](https://github.com/whitesmith/rubycritic) - a code quality analysis tool for Ruby\n- [Ruby](https://www.ruby-lang.org/en/) - a dynamic, object oriented programming language\n- [SimpleCov](https://github.com/colszowka/simplecov) - a code coverage analysis tool for Ruby\n- [Sinatra](http://sinatrarb.com/) - a DSL for creating Ruby web applications\n- [Travis CI](https://travis-ci.org/) - a continuous integration platform and deployment manager\n\n## Wireframes\n\n![mobile first interface design](./public/images/wireframes.png)\n\n## Resources\n\n- [wireframe.cc](https://wireframe.cc/) - a wireframe tool\n- [Learn how to create custom checkboxes and radio buttons with CSS.](https://www.w3schools.com/howto/howto_css_custom_checkbox.asp)\n- Icon made by [Freepik](https://www.flaticon.com/authors/freepik) from www.flaticon.com\n\n## License\n\nCheckbo**x**er is released under the [MIT License](./LICENSE.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruthmoog%2Fcheckboxer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruthmoog%2Fcheckboxer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruthmoog%2Fcheckboxer/lists"}