Table of contents

• 1. Getting started
  • 1.1. Installation
• 2. Documentation
• 3. Development
  • 3.1. Requirements
  • 3.2. Setup
• 4. Appendix
  • 4.1. Useful commands
• 5. How to contribute
• 6. License

🪄 1. Getting Started

1.1. Installation

First, install the dependencies:

npm install [email protected] @kibisis/katavault-core

Then install the SDK using:

npm install @kibisis/katavault-react

Back to top ^

📚 2. Documentation

For full documentation on usage, see here.

Back to top ^

🛠 3. Development

3.1. Requirements

• Install Node v20.18.0+
• Install pnpm v10.13.0

Back to top ^

3.2. Setup

1. Install the dependencies:

$ pnpm install

Back to top ^

📑 4. Appendix

4.1. Useful Commands

| Command | Description | |-----------------------|-----------------------------------------------------------------------------| | pnpm build | Generates build and TypeScript declaration files to the dist/ directory. | | pnpm clean | Deletes the dist/ directory and the tsconfig.*.tsbuildinfo files. | | pnpm generate:index | Generates/overwrites the main index.ts file used for exporting all files. | | pnpm lint | Runs the linter based on the rules in eslint.config.mjs. | | pnpm prettier | Runs the prettier based on the rules in prettier.config.mjs. | | pnpm test | Runs Vitest. |

Back to top ^

👏 5. How to contribute

Please read the contributing guide to learn about the development process.

Back to top ^

📄 6. License

Please refer to the LICENSE file.

Back to top ^