Table Of Contents

• 1. Overview
• 2. Getting Started
  • 2.1. Requirements
  • 2.2. Installation
• 3. Appendix
  • 3.1. Useful Commands
• 4. How To Contribute
• 5. License

🗂️ 1. Overview

...TBA.

Back to top ^

🪄 2. Getting Started

2.1. Requirements

• Install Node v20.9.0+ (LTS as of 20th October 2024)

Back to top ^

2.2. Installation

Install the dependencies using:

npm install @kibisis/connect-kit

Back to top ^

📑 3. Appendix

3.1. Useful Commands

| Command | Description | |----------------------|----------------------------------------------------------------------------------| | yarn build | Builds the package to the dist/. | | yarn build:example | Builds the example app to the .example/. | | yarn check:types | Checks the types. | | yarn lint | Runs linting. | | yarn prettier | Runs prettier with the same configuration that is run on the pre-commit hooks. | | yarn start:example | Runs the example app at http://localhost:8080. | | yarn test | Runs the tests. |

Back to top ^

👏 4. How To Contribute

Please read the Contributing Guide to learn about the development process.

Back to top ^

📄 5. License

Please refer to the COPYING file.

Back to top ^