Go to file
Trevor Vallender fa802b81c5 Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
.git-hooks Add git hooks 2024-05-26 09:11:31 +01:00
app Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
bin Add User model 2024-04-14 11:10:10 +01:00
config Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
db Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
lib Initial commit 2024-04-13 11:22:40 +01:00
log Initial commit 2024-04-13 11:22:40 +01:00
public Initial commit 2024-04-13 11:22:40 +01:00
storage Initial commit 2024-04-13 11:22:40 +01:00
test Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
tmp Initial commit 2024-04-13 11:22:40 +01:00
vendor Initial commit 2024-04-13 11:22:40 +01:00
.dockerignore Initial commit 2024-04-13 11:22:40 +01:00
.gitattributes Initial commit 2024-04-13 11:22:40 +01:00
.gitignore Initial commit 2024-04-13 11:22:40 +01:00
.rubocop.yml Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
.ruby-version Ruby update (3.3.1) 2024-05-26 09:03:14 +01:00
Dockerfile Ruby update (3.3.1) 2024-05-26 09:03:14 +01:00
Gemfile Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
Gemfile.lock Sprockets to Propshaft migration 2024-05-26 09:38:17 +01:00
README.md Add git hooks 2024-05-26 09:11:31 +01:00
Rakefile Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
config.ru Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00

README.md

Tabletop Companion

Tabletop Companion is a lightweight way to assist you playing tabletop games, online with the video chat software of your choice or offline at a physical table.

Development setup

Spin up the application with ./bin/setup.

Run tests with rails test.

Git hooks

There is a pre-commit git hook stored in .git-hooks which can be installed by running .git-hooks/install.bash.

The hooks:

  • Run Rubocop
  • Run tests
  • Run Brakeman

Brakeman

If Brakeman issues are introduced, they should be immediately fixed or ignored with a note as to why it is not a real issue. To do so, run bundle exec brakeman -I.