Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions packages/backend/src/modules/collection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,27 @@

{
"id":"String",
"user_id":"String",
"date_time":"Date",
"url":"String"
"title":"String", *
"questions_id":["String"], *
"exams_id":["String"], *
"owner_id":"String", *
"shared_with": ["String"], *
"created_at":"Date", *
"updated_at":"Date", *
"superior_collection": "Collection", *
"inferior_collections": "Collection", *
"url":"String" *?
}

```

### Method

- Record browsing history
- Clear browsing history
- Create Collection *
- Update Collection *
- Delete Collection *
- Share Collection *
- Import Collection *
- Export Collection *
- Add Search to Collection *

11 changes: 6 additions & 5 deletions packages/backend/src/modules/exam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{
"id":"String",
"title":"String",
"header": {"logo" : "Image",
"header": {"logo" : "String",
"institution": "String",
"department": "String",
"grade": "String",
Expand All @@ -19,14 +19,15 @@
"location": "String"
},
"candidate": {"name": "String",
"registration_number": "String",
"signature": "String"},
"registration_number": "String",
"signature": "String"},
"instructions": "String",
"value":"Number",
"maximum_mark":"Number",
"owner_id":"String",
"timeout_to_completion":{
"duration":"Time",
"start_time":"Time",
"end_time":"Time",
"end_time": "Time",
"start_date":"Date",
"end_date":"Date"
},
Expand Down
21 changes: 13 additions & 8 deletions packages/backend/src/modules/marker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,24 @@
"color":"String",
"owner_id":"String",
"questions_id":["String"],
"urls":["String"],
"urls":["String"], *?
"exams_id":["String"],
"created_at":"Date",
"updated_at":"Date",
"shared_with": ["String"], *
"superior_markers": "Marker", *
"inferior_markers": "Marker" *
}

```

### Methods

- Add question to marker
- Add url to marker
- Add exam to marker
- Remove question from marker
- Remove url from marker
- Remove exam from marker
- Create Marker *
- Update Marker *
- Delete Marker *
- Share Marker *
- Import Marker *
- Export Marker *
- Add question to marker *
- Add exam to marker *
- Add url to marker *?
3 changes: 2 additions & 1 deletion packages/backend/src/modules/question/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"is_public":"Boolean",
"comments_id":["String"],
"tags": ["String"],
"keywords": ["string"],
"alternatives":[
{
"id":"String",
Expand All @@ -21,9 +22,9 @@
"position_fixed": "Boolean"
}
],
"archived": "Boolean",
"created_at":"Date",
"updated_at":"Date",
"archived": "Boolean"
}

```
Expand Down