README.md

PubKey UI Starter

Starter for a PubKey UI project.

Warning

PubKey UI is unstable, there can be minor and major changes at any time.

Getting Started

Prerequisites

• Node.js (v20 or higher)
• PNPM (v8 or higher)
• Git

Tip

If you don't have PNPM installed, you can install it using corepack:

corepack enable
corepack prepare pnpm@8 --activate

Installation

1. Clone the repository:

git clone https://github.com/pubkeyapp/pubkey-ui-starter my-app
cd my-app
pnpm install

Development

Start the API app:

pnpm dev:api

Start the web app:

pnpm dev:web

Build

Build the API app:

pnpm build:api

Build the web app:

pnpm build:wev

Lint

pnpm lint

Test

pnpm test

Add Anchor

This project is compatible with the generators from create-solana-dapp.

You can use it to generate an Anchor application:

pnpm add -D @solana-developers/preset-anchor
pnpm nx generate @solana-developers/preset-anchor:application anchor --dry-run

With this base set up, you can now add Anchor programs and tests to your project.

pnpm nx generate @solana-developers/preset-anchor:template --projectName anchor --directory anchor --template counter counter --dry-run

License

MIT