Skip to content

Commit 3130d35

Browse files
committed
update readme
1 parent 00fc74c commit 3130d35

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

readme.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,19 @@ Modular toolkit for the construction of interactive tutoring systems, with exper
1111

1212
Think: the FOSS lovechild of Anki, Duolingo, Wikipedia, and MathAcademy, with a more generalized surface area for the types of content and skills that can be exercised.
1313

14+
Also: friendly with local-first and static-deployments.
15+
1416
## Quick Start
1517

16-
### For Course Creators (building *with* `vue-skuilder`) (start here!)
18+
### For Course Creators (building *with* `vue-skuilder`) (recommmended start point!)
1719

18-
Install the Skuilder CLI to create your first course:
20+
Use the Skuilder CLI to create your first course:
1921

2022
```bash
21-
npm install -g skuilder # npx ok too!
23+
npm install -g skuilder
2224
skuilder init my-course --data-layer=static
25+
# Or:
26+
# npx skuilder init my-course --data-layer=static
2327
cd my-course
2428
npm run dev # serve your course locally
2529
npm run studio # edit your course content via web UI
@@ -33,10 +37,20 @@ Clone and develop the full platform:
3337
git clone https://github.com/patched-network/vue-skuilder.git
3438
cd vue-skuilder
3539
yarn install
36-
yarn setup # makes git submodule available - test database
37-
yarn dev # runs platform-ui, express API, and CouchDB
40+
yarn setup # makes git submodule available - test database, builds library packages
41+
```
42+
43+
After the setup, workflows will differdepending on what you are working on. To explore, I recommend:
44+
45+
```
46+
yarn dev:platform
3847
```
3948

49+
Which will build the components of the platform version of the software and serve locally.
50+
- database: `http://localhost:5984`, with admin accound `admin:password`.
51+
- express backend: `http://localhost:3000`
52+
- platform UI: `http://localhost:5173`
53+
4054
## Project Architecture
4155

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

0 commit comments

Comments
 (0)