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

pnpm dev

Build

pnpm build

Lint

pnpm lint

Test

pnpm test

Credits

• Thanks to opos-outliers for open sourcing their project, which this project is based on. (MIT License Copyright (c) 2023 TipLink)

License

MIT