Krmx API
Krmx provides implementations its protocol for server and clients written in TypeScript. The server implementation can be used in a NodeJS backend and the clients can be used in NodeJS or in a React frontend.
If you're looking for the SDK reference, you can use the TypeScript SDK reference generated from the Krmx source code.
If you decide to build your own Krmx implementation of a server or client in a different language or framework, then feel free to add that implementation by opening a pull request (opens in a new tab).
If you need help setting up a project with Krmx, then please following the instructions at Getting Started.
Server Implementation
The Krmx server implementation (@krmx/server) is a NodeJS backend server and is written in TypeScript. You can use the API documentation, TypeScript SDK reference, or source code (opens in a new tab) to learn more about the Server API.
Client Implementation
The Krmx client implementation (@krmx/client) is a NodeJS client and is written in TypeScript. You can use the API documentation, TypeScript SDK reference, or source code (opens in a new tab) to learn more about the Client API.
React Client Implementation
The Krmx React client implementation (@krmx/client-react) provides an external store that wraps the Krmx Client, so that it can be easily used in React and is written in TypeScript. You can use the API documentation, TypeScript SDK reference, or source code (opens in a new tab) to learn more about the React Client API.
Base Library
The Krmx Base library (@krmx/base) is a shared library that contains the base classes and interfaces used by the Krmx Server and Clients. You can use the TypeScript SDK reference, or source code (opens in a new tab) to learn more about the Krmx Base API.
Getting Started
If you need help setting up a project with Krmx, then please following the instructions at Getting Started.