Skip to content
This repository was archived by the owner on Mar 28, 2024. It is now read-only.

Commit 6568207

Browse files
committed
Add ER diagram to README
1 parent d6a41ec commit 6568207

1 file changed

Lines changed: 12 additions & 54 deletions

File tree

README.md

Lines changed: 12 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,13 @@
1-
# README
2-
3-
This README would normally document whatever steps are necessary to get the
4-
application up and running.
5-
6-
Things you may want to cover:
7-
8-
* Ruby version
9-
10-
* System dependencies
11-
12-
* Configuration
13-
14-
* Database creation
15-
16-
* Database initialization
17-
18-
* How to run the test suite
19-
20-
* Services (job queues, cache servers, search engines, etc.)
21-
22-
* Deployment instructions
23-
24-
* ...
25-
26-
## Setup
27-
28-
### Prerequisites
29-
30-
This project depends on:
31-
32-
- [Ruby](https://www.ruby-lang.org/)
33-
- [Ruby on Rails](https://rubyonrails.org/)
34-
- [NodeJS](https://nodejs.org/)
35-
- [Yarn](https://yarnpkg.com/)
36-
- [Postgres](https://www.postgresql.org/)
37-
38-
### Intellisense
39-
40-
[solargraph](https://github.com/castwide/solargraph) is bundled as part of the
41-
development dependencies. You need to [set it up for your
42-
editor](https://github.com/castwide/solargraph#using-solargraph), and then run
43-
this command to index your local bundle (re-run if/when we install new
44-
dependencies and you want completion):
45-
46-
```sh
47-
bin/bundle exec yard gems
48-
```
49-
50-
You'll also need to configure your editor's `solargraph` plugin to
51-
`useBundler`:
52-
53-
```diff
54-
+ "solargraph.useBundler": true,
1+
```mermaid
2+
erDiagram
3+
Teacher ||--o{ EmailAddress : ""
4+
Teacher ||--o{ Mentorship : "Mentor"
5+
Teacher ||--o{ Tenureship : ""
6+
School ||--|{ Tenureship : ""
7+
Tenureship ||--|{ Mentorship : "Mentee"
8+
9+
School ||--|{ School : "Trust"
10+
Mentorship ||--|{ InductionPeriod : ""
11+
AppropriateBody ||--|{ InductionPeriod : ""
12+
InductionProgramme ||--|{ InductionPeriod : ""
5513
```

0 commit comments

Comments
 (0)