ordzaar / ordit-sdk

Ordit is an SDK project for Bitcoin Wallet, Ordinals and Inscriptions

Ordit

Ordit is an SDK project for Bitcoin Wallet, Ordinals and Inscriptions

Setup

This project is setup with pnpm workspaces and turbo. It follows a monorepo architecture for all its applications.

In this workspace, you can refer to pnpm-workspace.yaml on how the project is structured.

packages/
├─ sdk/

Developing & Contributing

Thanks for contributing, appreciate all the help we can get. Feel free to make a pull-request, we will guide you along the way to make it mergeable.

Prerequisites

You'll need to have pnpm installed on your system. If it's not yet installed, you can get it via npm using:

npm install -g pnpm
pnpm i

Running in Development Mode

Execute the following command below and it will run the build process in watch mode.

pnpm dev

Documentation

Documentation is done using Docusaurus. When adding new features or modifying existing ones, please include all documentation updates within the same pull-request.

License & Disclaimer

By using Ordit (this repo), you (the user) agree to be bound by the terms of this license.