Skip to content

Commit 15bb80a

Browse files
committed
clarify courseware package responsibilities
1 parent bc87227 commit 15bb80a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ yarn install
3636
yarn setup # makes git submodule available - test database, builds library packages
3737
```
3838

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:
4040

4141
```
4242
yarn dev:platform
@@ -51,7 +51,7 @@ Which will build the components of the platform version of the software and serv
5151

5252
This monorepo is structured to support both **platform development** and **course creation**.
5353

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.
5555

5656
Here:
5757

@@ -82,9 +82,11 @@ There are several UI *application* packages:
8282

8383
And some shared UI packages:
8484
- `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)
8685
- `edit-ui`: course editing widgets used in both `studio-ui` and `platform-ui`
8786

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+
8890
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`
8991

9092
### Glue

0 commit comments

Comments
 (0)