Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 917 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 917 Bytes

Contributing

Repo overview

  • packages/: Turnkey npm packages.
  • examples/: Examples and templates. Won't be published to npm.
  • internal/: Internal scripts and configs. Won't be published to npm.

Getting started

Clone the repo:

$ git clone https://github.com/tkhq/sdk/
$ cd sdk/

Install nvm (node version manager):

$ wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

Now open a new terminal to install Node.js:

$ nvm install # Install the version specified in `.nvmrc`
$ nvm use # Activate the local version

Use corepack to install/manage pnpm:

$ corepack enable
$ pnpm --version # Should output "8.4.0"

Finally, install dependencies and compile source code:

$ pnpm install -r
$ pnpm run -w build-all