From 22ed95983e720dd97b02f77130c913887b0a24d2 Mon Sep 17 00:00:00 2001 From: Oliver Akins Date: Mon, 7 Mar 2022 00:01:00 -0600 Subject: [PATCH] Add steps relating to the weirdness that is the common module --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1aba3b6..60c096f 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,15 @@ ## Development: Below are the steps required to run the code in development mode: - 1. Clone the git repository - 2. Go into the common code module: `cd common` - 3. Tell the Typescript compiler to watch for all updates in the module using: - `tsc --watch` - 4. In a new terminal: `cd web-svelte` - 5. Install the required dependencies: `pnpm install` - 6. Run Vite: `pnpm dev` \ No newline at end of file + 1. Clone the git repository + 2. Go into the common code module: `cd common` + 3. Build the code for commonjs and ES module distribution with: `make` + 4. In a new terminal: `cd web-svelte` + 5. Install the required dependencies: `pnpm install` + - If the `common` module fails to import, link it with `pnpm link ../common/esm` + 6. Run Vite: `pnpm dev` + 7. In a new terminal: `cd server` + 8. Install the required dependencies: `pnpm install` + - If the `common` modules fails to import, link it with `pnpm link ../common/cjs` + 9. Compile the server code with `tsc` + 10. Run the server code with `pnpm start` \ No newline at end of file