@easylayer/transport-sdk
v1.2.0
Published
A lightweight SDK for easy client-side integration with EasyLayer applications
Readme
EasyLayer Transport SDK
A lightweight SDK for easy client-side integration with EasyLayer-based applications. Provides a unified interface for sending queries and subscribing to events over different transport protocols (HTTP, WebSocket, IPC). Designed for seamless communication with our apps.
Table of Contents
Developer Setup
- Clone the repository:
git clone https://github.com/easylayer/transport-sdk.git
cd transport-sdk- Install dependencies:
yarn install- Build the SDK:
yarn build- Run tests:
yarn test:unit
yarn test:e2e
yarn test- Lint and format:
yarn lint
# or
yarn lint:fixDocumentation
All released documentation versions are available in the docs/ folder.
Contributing
We welcome contributions! To get started:
- Fork this repository and create a new branch for your feature or bugfix.
- Make your changes and ensure all tests and lints pass locally.
- Submit a pull request (PR) to the
developmentbranch.- All PRs must use the provided pull request template.
- Branch names and commit messages must follow the Conventional Changelog style. Allowed types:
feat,fix,infra,refactor,chore,BREAKING(see.czrcfor details). Please use descriptive messages for each commit. - All PRs are automatically checked by our GitHub Actions workflow (build, lint, unit tests, e2e tests).
Issue Reporting
If you encounter a bug or have a feature request, please open an issue and provide as much detail as possible.
License
This project is licensed under the MIT License.
