Getting Started Developing StarTree Internals

Prerequisites

Make sure to have these tools installed (so far only tested on a Mac):

• git
• node (version 18+)
• pnpm (version 8.10+)

We use pnpm for managing Node.js packages for now, instead of npm.

Clone and Wire-up StarTree Repos

Do a git clone on all the major @termsurf StarTree repos from GitHub in one fell swoop. See the full script which runs below.

curl https://star.surf/book/make/load | bash

This script places you into a new directory termsurf/seed.tree, which you can cd into later if you lose your spot.

Once you have those cloned and they get linked up, you can start developing on the internals woo! Try running the tests which work off all the linked repos (this command works inside the termsurf/seed.tree folder).

pnpm test