Go to file
Trevor Vallender 7faebf0173 Use gem for dice rolling 2024-07-08 15:08:17 +01:00
.git-hooks Add git hooks 2024-05-26 09:11:31 +01:00
.kamal/hooks Set up Kamal 2024-06-19 14:08:12 +01:00
app Use gem for dice rolling 2024-07-08 15:08:17 +01:00
bin Add User model 2024-04-14 11:10:10 +01:00
config Add sections based on templates 2024-07-04 08:43:19 +01:00
db Add template model 2024-06-29 09:16:37 +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 Use gem for dice rolling 2024-07-08 15:08:17 +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
.env.development Disable signup in production 2024-06-19 18:28:15 +01:00
.env.test Disable signup in production 2024-06-19 18:28:15 +01:00
.gitattributes Initial commit 2024-04-13 11:22:40 +01:00
.gitignore Disable signup in production 2024-06-19 18:28:15 +01:00
.rubocop.yml Enable frozen_string_literal cop 2024-05-26 11:45:10 +01:00
.ruby-version Ruby 3.3.3 update 2024-06-17 09:05:53 +01:00
Dockerfile Set up Kamal 2024-06-19 14:08:12 +01:00
Gemfile Use gem for dice rolling 2024-07-08 15:08:17 +01:00
Gemfile.lock Use gem for dice rolling 2024-07-08 15:08: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
todo.md Add sections based on templates 2024-07-04 08:43:19 +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.