Kibisis Connect Kit
The UI kit to allow dApps to connect to the Kibisis wallets.
### Table Of Contents
* [1. Overview](#-1-overview)
* [2. Getting Started](#-2-getting-started)
- [2.1. Requirements](#21-requirements)
- [2.2. Installation](#22-installation)
* [3. Appendix](#-3-appendix)
- [3.1. Useful Commands](#31-useful-commands)
* [4. How To Contribute](#-4-how-to-contribute)
* [5. License](#-5-license)
## 🗂️ 1. Overview
...TBA.
[Back to top ^][table-of-contents]
## 🪄 2. Getting Started
### 2.1. Requirements
* Install [Node v20.9.0+][node] (LTS as of 20th October 2024)
[Back to top ^][table-of-contents]
### 2.2. Installation
Install the dependencies using:
```shell
npm install @kibisis/connect-kit
```
[Back to top ^][table-of-contents]
## 📑 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](http://localhost:8080). |
| `yarn test` | Runs the tests. |
[Back to top ^][table-of-contents]
## 👏 4. How To Contribute
Please read the [**Contributing Guide**][contribute] to learn about the development process.
[Back to top ^][table-of-contents]
## 📄 5. License
Please refer to the [COPYING][copying] file.
[Back to top ^][table-of-contents]
[contribute]: ./CONTRIBUTING.md
[copying]: ./COPYING
[node]: https://nodejs.org/en/
[table-of-contents]: #table-of-contents