Oliver/Gravwell-Online
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add steps relating to the weirdness that is the common module

Browse source
This commit is contained in:
Oliver Akins 2022-03-07 00:01:00 -06:00
parent e253a71b67
commit 22ed95983e
No known key found for this signature in database
GPG key ID: 3C2014AF9457AF99
1 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -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`
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`