PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/guides/development.md
Yao Wang ec6d824b88
docs(contribute doc): move the guides folder to root folder (#329) 
- make sure the contribute doc can refer to the guides
2021-11-21 12:09:52 +00:00

712 B
Raw Blame History

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, 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.

  • Run yarn docs to build the docs via ts-doc.