Core packages

Core packages of the Open Pioneer Trails client framework.

• Samples: latest | dev
• API Documentation: latest | dev
• User manual

Getting started

Requirements: Node >= 20, pnpm >= 10.

To start the development server, run:

$ pnpm install # initially and always after changing package dependencies
$ pnpm dev     # starts dev server
  VITE v4.3.9  ready in 832 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help

To run tests:

# all tests
$ pnpm test
# only run certain tests, only core packages in this case (also see vitest docs)
$ pnpm test ./src/packages/core

For more details, consult the starter project's Repository Guide.

Branches

• main: Current development state.
• 3.x (Legacy): Contains the 3.x versions based on Chakra v2.

Packages

This repository publishes the following packages:

Name	Version
@open-pioneer/authentication
@open-pioneer/authentication-keycloak
@open-pioneer/base-theme
@open-pioneer/chakra-snippets
@open-pioneer/core
@open-pioneer/http
@open-pioneer/integration
@open-pioneer/local-storage
@open-pioneer/notifier
@open-pioneer/react-utils
@open-pioneer/reactivity
@open-pioneer/runtime
@open-pioneer/test-utils

License

Apache-2.0 (see LICENSE file)