Skip to content

Commit

Permalink
Update/docs/data architecture (#424)
Browse files Browse the repository at this point in the history
* Update: add database schema section in data-architecture.md

* Update: change the database models image in data-architecture.md

* refacto: move images in the doc into docs/ directory
  • Loading branch information
LouisVdwl authored May 30, 2024
1 parent dca61fc commit 5bf1f56
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 2 deletions.
Binary file removed database_models.jpg
Binary file not shown.
7 changes: 5 additions & 2 deletions docs/data-architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Database models

![Database models](../database_models.jpg 'Database models')
![Database models](database_models.jpg 'Database models')

**User**
Stores basic profile data for a user and relationships.
Expand All @@ -27,4 +27,7 @@ Stores data related to courses in Storyblok, copying the story id's. The `Sessio
Stores relationship between a `User` and `Course` records, once a user has started a course. A users progress (`completed`) for the course is updated (`true`) when all related `SessionUser` records are `completed` for the related `Course`.

**SessionUser**
Stores relationship between a `User` and `Session` records, once a user has started a session. A users session progress (`completed`) for the session is updated (true) when the `/complete` endpoint is called.
Stores relationship between a `User` and `Session` records, once a user has started a session. A users session progress (`completed`) for the session is updated (true) when the `/complete` endpoint is called.

## Database Schema
![Database schema](database_schema.png)
Binary file added docs/database_models.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/database_schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5bf1f56

Please sign in to comment.