We prefer using pnpm for installing dependencies and running scripts.
The main branch is locked for the push action. For proposing changes, use the standard pull request approach. It's recommended to discuss fixes or new functionality in the Issues, first.
This project was generated with svelte-kit. Library code can be found in the src/lib directory.
Run pnpm package:watch to rebuild the library on each update.
In the examples directory you can find example apps, to run them, navigate to the given directory and execute pnpm dev. The app will run on localhost:3000 and reload automatically on changes.
Run pnpm test to execute the unit tests via Jest.
We follow Conventional Commits for committing changes. We use git hooks to check that the commit message is correct.
The library is automatically released and published to NPM on every push to the main branch if there are relevant changes. The workflow must be approved by one of the maintainers, first.
We use typedoc to generate docs. To generate docs run:
pnpm docsThe docs will be generated into ./docs directory.
The docs are automatically deployed to Github Pages on every push to the main branch.
To get more help on the svelte-kit check out the documentation page.