2024-05-26 08:06:27 +00:00
|
|
|
# Tabletop Companion
|
2024-04-13 10:22:40 +00:00
|
|
|
|
2024-05-26 08:06:27 +00:00
|
|
|
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.
|
2024-04-13 10:22:40 +00:00
|
|
|
|
|
|
|
|
## Development setup
|
|
|
|
|
|
|
|
|
|
Spin up the application with `./bin/setup`.
|
|
|
|
|
|
|
|
|
|
Run tests with `rails test`.
|
2024-05-26 08:11:31 +00:00
|
|
|
|
|
|
|
|
### 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`.
|
|
|
|
|
|
|
|
|
|
|
