tldraw/guides/development.md

# Development

From the root folder:

- Run `yarn` to install dependencies.

- Run `yarn start` to start the development server for the package and for the example.

- Open `localhost:5420` to view the example project.

**Note:** The multiplayer examples and endpoints currently require an API key from [Liveblocks](https://liveblocks.io/), however the storage services that are used in tldraw are currently in alpha and (as of November 2021) not accessible to the general public. You won't be able to authenticate and run these parts of the project.

Other scripts:

- Run `yarn test` to execute unit tests via [Jest](https://jestjs.io).

- Run `yarn docs` to build the docs via [ts-doc](https://typedoc.org/).
updates docs / readmes / adds contributor guide 2021-11-11 12:11:21 +00:00			`# Development`

			`From the root folder:`

			- Run `yarn` to install dependencies.

			- Run `yarn start` to start the development server for the package and for the example.

			- Open `localhost:5420` to view the example project.

1.0.0 (#267) * remove sponsorwall for main route * Adds sponsorship link * Remove all sponsorwall * Fix sponsorship link appearance on dark mode * Add heart icon * Fix text bug * Fix toolbar, hide resize handles on sticky * Add eraser * Update Kbd.tsx * cleanup * base zoom delta on event deltaMode * Fix image in example * Fix eraser icon * eraser tool resets to previous tool * Update EraseTool.spec.ts * Improves support for locked shapes * Update _document.tsx * Update CHANGELOG.md * Adds multiplayer menu, fix develop route in example * Tighten up top panel padding * Update top bar, bump packages * refactor TLDrawState -> TLDrawApp, mutables, new tests * Fix scaling bug, delete groups bug * fix snapping * add pressure to points * Remove mutables, rename to tldraw (or Tldraw) * Clean up types, add darkmode prop * more renaming * rename getShapeUtils to getShapeUtil * Fix file names * Fix last bugs related to renaming * Update state to app in tests * rename types to TD * remove unused styles / rename styles * slight update to panel * Fix rogue radix perf issue * Update ZoomMenu.tsx * Consolidate style panel * Fix text wrapping in text shape, improve action menu * Fix props * add indicators for tool lock * fix calloits * Add click to erase shapes * Slightly improve loading screen * Update PrimaryTools.tsx * remove force consistent filenames from tsconfig * Update useTldrawApp.tsx * fix capitalization * Update main.yml 2021-11-16 16:01:29 +00:00			`Note: The multiplayer examples and endpoints currently require an API key from [Liveblocks](https://liveblocks.io/), however the storage services that are used in tldraw are currently in alpha and (as of November 2021) not accessible to the general public. You won't be able to authenticate and run these parts of the project.`
updates docs / readmes / adds contributor guide 2021-11-11 12:11:21 +00:00
			`Other scripts:`

			- Run `yarn test` to execute unit tests via [Jest](https://jestjs.io).

			- Run `yarn docs` to build the docs via [ts-doc](https://typedoc.org/).