theatre/packages/playground/README.md

13 lines
675 B
Markdown
Raw Normal View History

2021-10-05 12:22:43 +02:00
# The playground
2021-10-06 10:21:55 +02:00
The playground is the quickest way to hack on the internals of Theatre. It uses a simple ESBuild config that builds all the related packages in one go, so you _don't_ have to run a bunch of build commands separately to start developing.
2021-10-05 12:22:43 +02:00
## How to use
Simply run `yarn run serve` in this folder to start the dev server.
2021-10-06 10:21:55 +02:00
The first time you run `serve`, an `src/index.ts` file will be created. This file is the entry point, and it won't be comitted to the repo, so you're free to change it.
2021-10-05 12:22:43 +02:00
2021-10-06 10:21:55 +02:00
There are some shared playgrounds in `src/shared` which are committed to the repo. You can make your own playgrounds in `src/personal` which will be `.gitignore`d.
2021-10-05 12:22:43 +02:00