Skip to content

Commit 48e3227

Browse files
committed
update readme
1 parent 6ebb6d8 commit 48e3227

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

readme.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,19 @@ Aiming toward effective libraries and a main learner-loop to enable:
1515

1616
## Project Architecture
1717

18-
This monorepo contains three primary components:
18+
This monorepo contains three top-level system components:
1919

20-
- **Vue SPA Frontend** (`packages/vue`): Vue 3 + Vuetify 3 progressive web app
20+
- **Vue SPA Frontend** (`packages/platform-ui`): Vue 3 + Vuetify 3 progressive web app
2121
- **Express API** (`packages/express`): Node.js backend API
2222
- **CouchDB Database**: Storage layer with replication protocol support
2323

24+
Which are in turn built from the helper packages:
25+
26+
- `common`: some core logic and interfaces that define communication between project components
27+
- `common-ui`: UI components useful in both a `platform` and standalone `course` context
28+
- `courses`: logic and interfaces for both generic and domain specific courses.
29+
- `db`: interfaces for the application's communication with the data later, and an implementation for CouchDB backend via PouchDB
30+
2431
## Development Quick Start
2532

2633
### Prerequisites
@@ -34,28 +41,28 @@ This monorepo contains three primary components:
3441
```bash
3542
git clone https://github.com/patched-network/vue-skuilder.git
3643
cd vue-skuilder
37-
git submodule update --init --recursive
44+
git submodule update --init --recursive # a test-time database dump
3845
yarn install
3946
yarn dev
4047
```
4148

42-
This will:
43-
- Build the common package
44-
- Start a local CouchDB instance in Docker with test data
45-
- Launch the Express backend server
46-
- Launch the Vue frontend (http://localhost:5173)
49+
`dev` here:
50+
- Builds packages
51+
- Starts a local CouchDB instance in Docker with test data (http://localhost:5984)
52+
- Launches the Express backend server (http://localhost:3000)
53+
- Launches the Vue frontend (http://localhost:5173)
4754

4855
## Production Build
4956

5057
```bash
5158
yarn build
5259
```
5360

54-
This builds all packages and outputs the frontend as a static web app in the `packages/vue/dist` folder and the backend in `packages/express/dist`.
61+
This builds all packages and outputs the frontend as a static web app in the `packages/platform-ui/dist` folder and the backend in `packages/express/dist`.
5562

5663
## License
5764

5865
This project is licensed under:
5966

6067
- **AGPL-3.0** for the core platform: [License](https://opensource.org/licenses/AGPL-3.0)
61-
- **MIT** for materials in base course content: [License](https://opensource.org/licenses/MIT)
68+
- **MIT** for materials in the `courses` package: [License](https://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)