kaboom-db / kaboom

A comic tracker, written in Ruby on Rails

Kaboom

Track your comic book collection. Kaboom is focused on tracking comic books and issues, and retrieves metadata from the ComicVine API. A bit like how Trakt does so with TMDb.

Development

Versions:

• Ruby 3.3.1
• Rails 7.0.8

Requirements:

• Redis 6.2+
• Node (yarn)

Easy setup:

bin/setup

Seed the database:

bin/rails db:seed

_{Note: Running seeds sends requests to ComicVine servers to import comics and issues. You will need an internet connection and an API key.}

Run the dev server:

bin/dev

Testing

All new code should be thoroughly tested. Kaboom uses RSpec as its testing framework.

To run all tests:

bundle exec rspec

While writing tests, you may find it useful for them to run when saving files. To do this, run:

bundle exec guard

Linting

Kaboom uses standardrb (.rb) and eslint (.js, .ts) for linting. CI will fail if linting isn't correct.

To fix all fixable linting issues:

bundle exec standardrb --fix

Lint ERB files:

bundle exec erblint --cache --lint-all

Lint all Javascript/Typescript files:

yarn lint:js --fix