- nodejs >= 16
- yarn (for managing dependencies)
Notes:
- this project uses yarn (berry) workspaces
- this project does not use yarn (berry) plug'n'play
After cloning the repository, from the project's root directory run yarn
to
install packages.
From the project's root directory, you can run the following scripts:
yarn lint
: lints the code (with eslint)yarn check-formatting
: checks code formattingyarn fix-formatting
: fixes code formattingyarn test
: runs each workspace's testsyarn build
: builds each workspace's codeyarn workspace package-name run script-name
: run a workspace-specific script
@excalideck/deck
: contains the definitions of the core interfaces (Deck
,Slide
, etc) and functions to operate on them@excalideck/excalideck-editor
: contains theExcalideckEditor
component@excalideck/persistent-excalideck-editor
: contains thePersistentExcalideckEditor
component, that builds upon theExcalideckEditor
component, adding file-saving capabilities@excalideck/excalideck-file
: contains theExcalideckFile
object, used to save and load Excalideck files@excalideck/slide-renderers
: contains renderers to render slides in different formats@excalideck/webapp
: contains the Excalideck webapp
- prettier is used to enforce code formatting
- eslint is used to enforce some common coding best practices
When a commit is pushed, the CI server runs the automated QA checks.
When a tag is pushed, the CI server - if QA checks succeed, and if approval is given by one of the maintainers - builds and publishes artifacts.