You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ yarn install
36
36
yarn setup # makes git submodule available - test database, builds library packages
37
37
```
38
38
39
-
After the setup, workflows will differdepending on what you are working on. To explore, I recommend:
39
+
After the setup, workflows will differ depending on what you are working on. To explore, I recommend:
40
40
41
41
```
42
42
yarn dev:platform
@@ -51,7 +51,7 @@ Which will build the components of the platform version of the software and serv
51
51
52
52
This monorepo is structured to support both **platform development** and **course creation**.
53
53
54
-
Broadly: an education system has `User` and `Content` as endpoints, with `UI` as the mediating software in between.
54
+
Broadly: an education system has `User` and `Content` as endpoints, with `UI` as the mediating software in between. We aim for flexible storange and delivery of User and Content data, and for easily extensible `UI` for rendering custom course content.
55
55
56
56
Here:
57
57
@@ -82,9 +82,11 @@ There are several UI *application* packages:
82
82
83
83
And some shared UI packages:
84
84
-`common-ui`: a library of reusable Vue components and utilities
85
-
-`courses`: a package containing domain-specific course logic and content types, also base-types for course content rendering components (e.g., a Chessboard component for a chess course)
86
85
-`edit-ui`: course editing widgets used in both `studio-ui` and `platform-ui`
87
86
87
+
88
+
The `courseware` package contains base-types for course content rendering components, and also some domain-specific course logic and content type definitions (e.g., a Chessboard component for a chess course). In order to create custom content rendering components, you will extend from these base types.
89
+
88
90
All web UI is built with Vue 3 and Vuetify 3, in TypeScript, mostly with Composition API and Pinia state management. All web UI shares most of its config via `./vite.config.base.json`
0 commit comments