Ethlete Frontend SDKs

Monorepo for all the Ethlete frontend SDKs

Documentation

• main branch: https://ethlete-sdk.web.app/
• next branch: https://next-ethlete-sdk.web.app/

Packages

Below is a list of all current Ethlete SDKs. An up-to-date list of current todo's can be found inside the issues tab.

@ethlete/core

Core functionalities and utils.

yarn add @ethlete/core
# or
bun add @ethlete/core

@ethlete/query

Fetch wrapper with caching, request templates, GQL support and Angular helpers

yarn add @ethlete/query
# or
bun add @ethlete/query

@ethlete/cdk

Component development kit for Ethlete with a11y and performance in mind.

yarn add @ethlete/cdk
# or
bun add @ethlete/cdk

@ethlete/components

Themeable components based on the Ethlete design system.

yarn add @ethlete/components
# or
bun add @ethlete/components

@ethlete/dsp

Utilities for creating and managing design systems.

yarn add @ethlete/dsp
# or
bun add @ethlete/dsp

@ethlete/cli

CLI helper functions.

yarn add @ethlete/cli
# or
bun add @ethlete/cli

@ethlete/theming

Utilities to make component theming easier.

yarn add @ethlete/theming
# or
bun add @ethlete/theming

@ethlete/contentful

Helpers for usage with Contentful (e.g. rich text rendering).

yarn add @ethlete/contentful
# or
bun add @ethlete/contentful

@ethlete/types

Up to date typescript definitions for the Ethlete REST API as well as other types shared across SDKs.

yarn add -D @ethlete/types
# or
bun add @ethlete/types

How to contribute

This mono repository uses:

• Bun as a package manager.
• Conventional commits for commit messages.
• Changesets for version management and automated releases.

General workflow

Clone the repository:

git clone https://github.com/ethlete-io/ethdk.git

Install dependencies:

bun install

Create a feat, fix or other branch:

git checkout -B feat/example

Commit your changes via git-cz:

bun commit

If the changes made should result in a version bump, create a changeset and commit the generated file. All SDKs adhere to the semantic versioning guidelines.

bun change

# OR if the command above fails for some reason:
bunx changeset

Now all that's left is to create a PR and make sure that all workflows pass.

Useful scripts

Script	Description
commit	Run the commit assistant
change	Run the changeset assistant
start	Run the playground (test) app in serve mode
storybook	Run the storybook instance
nx:update	Run nx update
nx:migrate	Apply migrations created by nx:update