doc: add a visualization of the database models
Re-generate the schema using `bin/rake erd`. NB: there's a way to update the PDF automatically after each migration. But it requires `graphviz` to be installed locally, which I'm not sure I want to require by default.
This commit is contained in:
parent
0570692d4a
commit
1767df33b0
5 changed files with 22 additions and 0 deletions
8
doc/README.md
Normal file
8
doc/README.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
## database_models.pdf
|
||||
|
||||
The database models document is generated using the `rails-erd` gem.
|
||||
|
||||
To update the generated PDF file:
|
||||
|
||||
1. Install `graphviz` (e.g. `brew install graphviz`)
|
||||
2. Run `bin/rake erd`
|
BIN
doc/database_models.pdf
Normal file
BIN
doc/database_models.pdf
Normal file
Binary file not shown.
Loading…
Add table
Add a link
Reference in a new issue