AVM Web Provider

A TypeScript implementation that allows clients to connect and interact with web-based providers.

---

Table of Contents

• 1. Overview
• 2. Development
  • 2.1. Requirements
  • 2.2. Setup
  • 2.3. Build
• 3. Appendix
  • 3.1. Useful Commands
• 4. How To Contribute

🔭 1. Overview

This project is the monorepo that contains the source code for the avm-web-provider package as well as the documentation.

^{Back to top ^}

🛠 2. Development

2.1. Requirements

• Install Node v22+
• Install pnpm v10+

^{Back to top ^}

2.2. Setup

1. Install the dependencies:

$ pnpm install

^{Back to top ^}

2.3. Build

• To build simply run:

$ pnpm build

This will compile the Typescript source code into a dist/ directory.

^{Back to top ^}

📑 3. Appendix

3.1. Useful Commands

Command	Description
pnpm build	Builds the source code into the dist/ directory.
pnpm build:docs	Builds the documentation into the .docusaurus/ directory.
pnpm check:types	Performs a type check on the src/ directory.
pnpm lint	Runs the linter on .js and .ts files.
pnpm prettier	Runs the prettier on .js and .ts files.
pnpm serve:docs	Serves the built documentation from the .docusaurus/ directory.
pnpm start:docs	Builds and runs the documentation in a development environment with hot reloading.
pnpm 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 ^}