1.1.0 • Published 5 months ago

@kibisis/katavault-core v1.1.0

Weekly downloads
-
License
CC0-1.0
Repository
github
Last release
5 months ago

License: CC0-1.0 NPM Version

GitHub Release GitHub pre-release


Table of contents

🪄 1. Getting Started

1.1. Installation

First, install the dependencies:

npm install algosdk@3.x

Then install the SDK using:

npm install @kibisis/katavault-core

Back to top ^

📚 2. Documentation

For full documentation on usage, see here.

Back to top ^

🛠 3. Development

3.1. Requirements

Back to top ^

3.2. Setup

  1. Install the dependencies:
$ pnpm install

3.3. Running the example

The example can be run by using:

pnpm -F @kibisis/katavault-core start

This will build a local copy of the SDK and start a development server running the example code in example/.

The example site will be running on http://localhost:8080.

Back to top ^

📑 4. Appendix

4.1. Useful Commands

CommandDescription
pnpm buildGenerates build and TypeScript declaration files to the dist/ directory.
pnpm cleanDeletes the dist/ directory and the tsconfig.*.tsbuildinfo files.
pnpm generate:indexGenerates/overwrites the main index.ts file used for exporting all files.
pnpm lintRuns the linter based on the rules in eslint.config.mjs.
pnpm prettierRuns the prettier based on the rules in prettier.config.mjs.
pnpm testRuns 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 ^