From 70237492f681187ee6ddfdee73e7f9ecef3525bc Mon Sep 17 00:00:00 2001 From: woolsox Date: Thu, 31 Oct 2019 09:55:03 -0400 Subject: [PATCH 1/2] Adds backend note for including ERD in README --- backend.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/backend.md b/backend.md index 781894a..5b191f1 100644 --- a/backend.md +++ b/backend.md @@ -1 +1,12 @@ # Backend + +## Entity-Relationship Diagrams [ERD] + +All projects should include regularly updated ERD files at the README level. + +Gem: +``` +https://github.com/voormedia/rails-erd +``` + +Note: This gem ships with SB's Boxcar template. From 85864d50580f61982d983058fef5a92095848381 Mon Sep 17 00:00:00 2001 From: woolsox Date: Fri, 22 Nov 2019 15:54:05 -0500 Subject: [PATCH 2/2] Update verbiage to match boxcars new functoinality --- backend.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/backend.md b/backend.md index 5b191f1..1cfb685 100644 --- a/backend.md +++ b/backend.md @@ -2,11 +2,11 @@ ## Entity-Relationship Diagrams [ERD] -All projects should include regularly updated ERD files at the README level. +All ```boxcar``` projects include the following gem: -Gem: ``` https://github.com/voormedia/rails-erd ``` -Note: This gem ships with SB's Boxcar template. +The gem is installed and set to auto-update a file named ```ER_Model.pdf``` after each migration. +This file is linked to in the ```README.md``` for documentation purposes.