fix npm cli; parameterize yjs port in trpc router (#571)

Author: lihebi

BUILD.md

@@ -0,0 +1,59 @@
+# Building CodePod
+
+First build the UI:
+
+```
+cd ui
+pnpm bulid
+```
+
+This will generate the frontend html/js files into `api/public` folder. Then build the app in `api/` folder:
+
+```
+cd api
+pnpm build
+```
+
+This will generate `api/build/cli.js`. This is the binary executable. You can
+install and test the app locally:
+
+```
+cd api
+npm install -g .
+```
+
+Now the `codepod` command is available. Test:
+
+```
+> which codepod
+# /opt/homebrew/bin/codepod
+> npm list --global
+# /opt/homebrew/lib
+# ├── [email protected] -> ./../../../Users/xxx/git/codepod/api
+> codepod /path/to/repo
+# ... 🚀 Server ready at http://localhost:4001
+```
+
+Remove the globally installed local package:
+
+```
+npm remove -g codepod
+```
+
+Now it's ready to publish. We will first publish to npm registry. First login to
+npm-cli, upgrade the version in `api/package.json` then:
+
+```
+npm publish
+```
+
+Now it is in npm at https://www.npmjs.com/package/codepod. Install it from npm:
+
+```
+# option 1: install
+npm install -g codepod
+codepod /path/to/repo
+
+# option 2: run with npx without install
+npx codepod /path/to/repo
+```

api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codepod",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "MIT",
   "scripts": {
     "build": "tsc",
@@ -9,7 +9,7 @@
     "test": "jest --config jest.config.js"
   },
   "bin": {
-    "codepod": "./build/bin.js"
+    "codepod": "./build/cli.js"
   },
   "dependencies": {
     "@trpc/server": "^10.43.0",

api/src/bin.ts api/src/cli.tsapi/src/bin.ts renamed to api/src/cli.ts

@@ -9,7 +9,8 @@ import { startServer } from "./server";
 // CMD: codepod /path/to/repo
 
 program
-  .version("0.0.1")
+  // get the version from package.json
+  .version(require("../package.json").version)
   .arguments("<repoPath>")
   .action(function (repoPath) {
     console.log("repoPath", repoPath);

api/src/server.ts

@@ -8,7 +8,7 @@ import { createSetupWSConnection } from "./yjs/yjs-setupWS";
 import { bindState, writeState } from "./yjs/yjs-blob";
 
 import cors from "cors";
-import { appRouter } from "./spawner/trpc";
+import { createSpawnerRouter, router } from "./spawner/trpc";
 
 export async function startServer({ port, blobDir }) {
   console.log("starting server ..");
@@ -21,10 +21,14 @@ export async function startServer({ port, blobDir }) {
   console.log("html path: ", path);
   app.use(express.static(path));
 
+  const yjsServerUrl = `ws://localhost:${port}/socket`;
+
   app.use(
     "/trpc",
     trpcExpress.createExpressMiddleware({
-      router: appRouter,
+      router: router({
+        spawner: createSpawnerRouter(yjsServerUrl),
+      }),
     })
   );