Skip to content

Commit c9b97a7

Browse files
committed
Remove rails erd
The newer version requires some changes to keep pdfs working I asked the team and no one is using it so remove, we can add it again if we have a need I did look at the generated output and it did look overly complex - I think a simplified curated diagram might be more useful
1 parent 9fb901a commit c9b97a7

3 files changed

Lines changed: 0 additions & 23 deletions

File tree

Gemfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ group :development, :test do
7373
end
7474

7575
group :development do
76-
gem 'rails-erd'
7776
gem 'ruby-lsp', require: false
7877
gem 'ruby-lsp-rspec', '~> 0.1.29', require: false
7978
end

Gemfile.lock

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ GEM
137137
regexp_parser (>= 1.5, < 3.0)
138138
xpath (~> 3.2)
139139
childprocess (4.1.0)
140-
choice (0.2.0)
141140
climate_control (1.2.0)
142141
coderay (1.1.3)
143142
concurrent-ruby (1.3.7)
@@ -322,7 +321,6 @@ GEM
322321
stringio
323322
time
324323
uri
325-
ostruct (0.6.3)
326324
paper_trail (17.0.0)
327325
activerecord (>= 7.1)
328326
request_store (~> 1.4)
@@ -396,11 +394,6 @@ GEM
396394
activesupport (>= 5.0.0)
397395
minitest
398396
nokogiri (>= 1.6)
399-
rails-erd (2.0.2)
400-
activerecord (>= 7.0)
401-
activesupport (>= 7.0)
402-
choice (~> 0.2.0)
403-
ostruct
404397
rails-html-sanitizer (1.7.0)
405398
loofah (~> 2.25)
406399
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
@@ -622,7 +615,6 @@ DEPENDENCIES
622615
rack-cors
623616
rack_content_type_default (~> 1.1)
624617
rails (~> 8.1.3)
625-
rails-erd
626618
rails_semantic_logger (~> 4.20)
627619
rspec
628620
rspec-rails

README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -151,20 +151,6 @@ Handled in `config/initializers/cors.rb`.
151151

152152
This API receives push event data from the [Raspberry Pi Learning](https://github.com/raspberrypilearning) organisation via webhooks. This data is used to create or update code projects related to the [Code Club Projects Site](https://projects.raspberrypi.org), and is processed using the `github_webhooks` gem in the `github_webhooks_controller`. For development purposes, these webhooks are mediated locally through `smee`, which runs in a Docker container.
153153

154-
### Database Structure
155-
156-
Once you have completed the initial setup and have everything running in a container, you can generate an Entity-Relationship Diagram (ERD) to help you to understand the database structure. In order to do this, start things up as usual in one terminal:
157-
158-
`docker-compose up`
159-
160-
then in a second terminal, create the ERD using:
161-
162-
`docker-compose exec api bundle exec erd`
163-
164-
then copy the created ERD out of the container with:
165-
166-
`docker cp "$(docker-compose ps -q api)":/app/EditorAPI-ERD.pdf .`
167-
168154
## Usage
169155

170156
### Projects

0 commit comments

Comments
 (0)