Get Starknet
Goals
- Allow Starknet dApps and wallets to seamlessly connect
- Lightweight and easy to use
- Fast integration, building and testing
- Customizable and extensible
- Open source and controlled by the community
Documentation
The documentation, including demos, is available on the official website.
Installation
Core package
# using npm
npm install @starknet-io/get-starknet-core starknet
# using yarn
yarn add @starknet-io/get-starknet-core starknet
# using pnpm
pnpm add @starknet-io/get-starknet-core starknet
Connect Wallet UI
# using npm
npm install @starknet-io/get-starknet-ui starknet
# using yarn
yarn add @starknet-io/get-starknet-ui starknet
# using pnpm
pnpm add @starknet-io/get-starknet-ui starknet
Development
You need Node and pnpm installed. Make sure to clone this repo and run:
pnpm install
pnpm build
To start watching for changes, run:
pnpm dev
and open http://localhost:5173/
Running tests
For running tests:
pnpm test
Releasing
master is the only long-lived branch. Open pull requests against master
and add a changeset for any change to a published package:
pnpm changeset
When changesets land on master, the release workflow opens a "Master branch
version bump" pull request. Merging it publishes the new versions to npm under
latest.