development.mdx 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. ---
  2. pagination_prev: "@excalidraw/excalidraw/installation"
  3. ---
  4. # Development
  5. This page relates to developing the `@excalidraw/excalidraw` package itself.
  6. ## Example app
  7. To start the example app using the `@excalidraw/excalidraw` package, follow the below steps:
  8. 1. Install the dependencies
  9. ```bash
  10. cd src/packages/excalidraw && yarn
  11. ```
  12. 2. Start the example app
  13. ```bash
  14. yarn start
  15. ```
  16. [http://localhost:3001](http://localhost:3001) will open in your default browser.
  17. The example is same as the [codesandbox example](https://ehlz3.csb.app/)
  18. ## Releasing
  19. ### Create a test release
  20. You can create a test release by posting the below comment in your pull request:
  21. ```bash
  22. @excalibot trigger release
  23. ```
  24. Once the version is released `@excalibot` will post a comment with the release version.
  25. ### Creating a production release
  26. To release the next stable version follow the below steps:
  27. ```bash
  28. yarn prerelease version
  29. ```
  30. You need to pass the `version` for which you want to create the release. This will make the changes needed before making the release like updating `package.json`, `changelog` and more.
  31. The next step is to run the `release` script:
  32. ```bash
  33. yarn release
  34. ```
  35. This will publish the package.
  36. Right now there are two steps to create a production release but once this works fine these scripts will be combined and more automation will be done.