Skip to content
unbikit

Development

This section is intended for code contributors.

First ensure that you have pnpm and Node.js installed in your development environment.

Next, install the project’s dependencies:

Terminal window
pnpm install

To run the demo (for local development) with documentation:

Terminal window
pnpm dev
# demo site should now be available from `http://localhost:4321/unbikit/`

To run linting/formatting/type-checking and run tests:

Terminal window
pnpm check

To run tests in “watch mode” with the Vitest UI:

Terminal window
pnpm test
# demo site should now be available from `http://localhost:51712/__vitest__/`

To run tests and generate a code coverage report:

Terminal window
pnpm test:coverage

To run the benchmarks:

Terminal window
pnpm bench

To build for production:

Terminal window
pnpm build

To build the demo and documentation for production and then view it:

Terminal window
pnpm build:app
pnpm preview:app
# demo site should now be available from `http://localhost:4321/unbikit/`

Verification is performed by the CI flow for all pull requests before they can be merged to the main branch. Commit logs are checked for Conventional Commits compliance as part of this flow.

References

Section titled “References”

Sources of reference material about decoding the .bik format: