Skip to content

kibis-is/connect-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kibisis logo

Kibisis Connect Kit

License: AGPL-3.0-or-later NPM Version GitHub Pre-release GitHub Release

The UI kit to allow dApps to connect to the Kibisis wallets.


Table of Contents

🗂️ 1. Overview

...TBA.

Back to top ^

🪄 2. Usage

2.1. Installation

Install using:

npm install @kibisis/connect-kit

Back to top ^

2.2. Getting Started

2.2.1. Initialization

First you will need to initialize Kibisis connect kit:

import { KibisisConnect } from '@kibisis/connect-kit';

const kibisisConnect = await KibisisConnect.init({
  genesisHash: '5pbhGq04byd0AgV/sbP+yITANqazgKBuaATr85n21wY=',
});

⚠️ NOTE: You MUST initialize Kibisis connect kit with a genesis hash for the desired network, but you can change this later.

Back to top ^

2.2.2. Connect

Once you have successfully initialized the Kibisis connect kit, you can fetch the accounts using the connect() function.

import { KibisisConnect } from '@kibisis/connect-kit';

const accounts = await kibisisConnect.connect();

Back to top ^

🗃️ 3. API Reference

Back to top ^

🪄 4. Development

4.1. Requirements

Back to top ^

4.2. Installation

Install the dependencies using:

pnpm install

Back to top ^

📑 5. Appendix

5.1. Useful Commands

Command Description
pnpm build Builds the package to the dist/.
pnpm build:example Builds the example app to the .example/.
pnpm check:types Checks the types.
pnpm generate:env Copies the .env.example to a .env file. This command does not overwrite a previous .env file.
pnpm lint Runs linting.
pnpm prettier Runs prettier with the same configuration that is run on the pre-commit hooks.
pnpm start:example Runs the example app at http://localhost:8080.
pnpm test Runs the tests.

Back to top ^

👏 6. How To Contribute

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

Back to top ^

📄 7. License

Please refer to the COPYING file.

Back to top ^

About

The UI kit to allow dApps to connect to the Kibisis wallets.

Resources

License

Contributing

Stars

Watchers

Forks

Contributors 2

  •  
  •