Skip to content

chore: add corepack setup to HACKING.md #468

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 26, 2025
Merged

chore: add corepack setup to HACKING.md #468

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions HACKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,19 @@ Please ensure that you have installed:

Run following commands to configure a just cloned project:

| Command | Purpose |
|-------------------|----------------------------------------------------------|
| `make preinstall` | Installs NPM packages for a web app. |
| `make wasm` | Builds WebAssembly binaries used by the web app. |
| `make go-index` | Generates Go packages index for autocomplete in web app. |
| Command | Purpose |
|-------------------|-------------------------------------------------------------------------------------------------------------|
| `corepack enable` | Enables [Corepack](https://nodejs.org/api/corepack.html) to use package manager version from `package.json` |
| `make preinstall` | Installs NPM packages for a web app. |
| `make wasm` | Builds WebAssembly binaries used by the web app. |
| `make go-index` | Generates Go packages index for autocomplete in web app. |

### Running Project

> [!IMPORTANT]
> If you see `command not found: yarn` error, please ensure that Corepack is enabled.
> See **First-time setup** section.

Front-end web app and Go API server are executed using separate make commands:

| Command | Purpose |
Expand Down
Loading