Switch to pnpm (#62)

Faster and streamlines the initial repo setup. Also made some changes to
improve running demos in "prod" mode to test on embedded devices.

Author: frank-weindel

.gitignore

@@ -10,3 +10,6 @@ build
 releases
 .tmp
 .env
+*.tgz
+# This project uses `pnpm` for package management
+package-lock.json

.npmrc

@@ -0,0 +1 @@
+engine-strict = true

README.md

@@ -13,32 +13,28 @@ Solid.
 ## Setup & Commands
 
 ```
-# Install renderer dependencies
-npm install
-
-# Install example dependencies
-cd examples
-npm install
+# Install renderer + example dependencies
+pnpm install
 
 # Build Renderer
-npm run build
+pnpm build
 
 # Build Renderer (watch mode)
-npm run watch
+pnpm watch
 
 # Run unit tests
-npm test
+pnpm test
 
 # Build API Documentation (builds into ./docs folder)
-npm run typedoc
+pnpm typedoc
 
 # Launch test examples in dev mode (includes Build Renderer (watch mode))
-npm start
+pnpm start
 
 # Launch test examples in production mode
 # IMPORTANT: To run test examples on embedded devices that use older browser versions
 # you MUST run the examples in this mode.
-npm run prod
+pnpm start:prod
 ```
 
 ## Test Examples

RELEASE.md

@@ -14,14 +14,14 @@ git checkout main
 git stash -u
 
 # Run the build once to make sure it completes without errors
-npm run build
+pnpm run build
 
 # Mark the version update
 # This creates a new tagged commit for the version
-npm version <release-increment> # patch/minor/major
+pnpm version <release-increment> # patch/minor/major
 
 # Publish the package to NPM
-npm publish --access public
+pnpm publish --access public
 
 # Push version commit to github
 git push

examples/README.md

@@ -6,17 +6,17 @@ URL parameters.
 ## Setup
 
 ```
-npm install
+pnpm install
 
 # Run code in dev mode (includes building Renderer in watch mode)
-npm start
+pnpm start
 
 # Build and run in production mode (vite builds the bundle files in the ./dist folder)
-npm run build && npm run preview
+pnpm start:prod
 ```
 
 **Very Important:** When making changes to the Renderer, the Renderer must be
-re-built before you will see the changes appear. `npm start` will run the
+re-built before you will see the changes appear. `pnpm start` will run the
 Renderer's build process in watch mode, but a build of the Renderer must be
 run before building these examples in production mode.
 
@@ -25,10 +25,10 @@ run before building these examples in production mode.
 cd ..
 
 # Build once
-npm run build
+pnpm build
 
 # Build in watch mode
-npm run watch
+pnpm watch
 ```
 
 ## URL Params