Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update dev instructions #15

Merged
merged 1 commit into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,31 @@ git clone https://github.com/MattFerraro/CADmium.git
cd CADmium
pnpm build:wasm
pnpm install
turbo dev
pnpm dev
```

You will need rust and wasm-pack working locally. See `vercel_build.sh` for an example of installing these dependencies.
## Tooling setup

### pnpm

We use pnpm to manage the monorepo. Please follow the instructions here to install: https://pnpm.io/installation#using-a-standalone-script

If you're new to node you can use pnpm to manage nodejs:

```shell
# https://pnpm.io/cli/env#use
pnpm env use --global 20
```

### rust

First install rust using rustup: https://rustup.rs

Then install wasm-pack

```shell
cargo install wasm-pack
```

## Running Tests

Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"@playwright/test": "^1.42.1",
"turbo": "^1.13.2"
},
"packageManager": "pnpm@8.15.5",
"engines": {
"node": ">=20.12.0",
"pnpm": ">=8.15.5"
Expand Down
Loading