Add web script, update README for web

toaq · Sep 5, 2023 · ee83bf5 · ee83bf5
1 parent 58fa40f
commit ee83bf5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -21,7 +21,7 @@ jobs:
         run: npm run prettier:check
 
       - name: Build project
-        run: npm run vite:build
+        run: npm run web:build
       - name: Upload production-ready build files
         uses: actions/upload-artifact@v3
         with:

diff --git a/README.md b/README.md
@@ -7,6 +7,13 @@ For proper PNG rendering, install
 
 ## Usage
 
+To run as a web app (at <http://localhost:5173/>):
+
+```sh
+npm install
+npm run web -- --port 5173
+```
+
 To run as a CLI app:
 
 ```sh

diff --git a/package.json b/package.json
@@ -28,7 +28,8 @@
 		"codegen": "npx nearleyc src/toaq.ne -o src/grammar.ts",
 		"ts:build": "npx tsc",
 		"ts:check": "npx tsc --noEmit",
-		"vite:build": "npx vite build"
+		"web": "npx vite",
+		"web:build": "npx vite build"
 	},
 	"repository": {
 		"type": "git",