tldraw/guides/development.md
Patrick Hultquist 8a198c6d42
Remove references to docs script (#1003)
* remove references to yarn docs

* add back ref to source & ts
2022-10-03 11:55:10 +01:00

15 lines
639 B
Markdown

# 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).