create-awarizon-app

The fastest way to start a new Awarizon project. One command scaffolds a complete app — package.json, config files, SDK wired up, and your API key pre-filled in .env. No manual setup required.

SCAFFOLD A NEW PROJECT

$npx create-awarizon-app

You will be prompted for a project name, template, language, and your API key. Hit enter to accept defaults.

Next.js 14App Router + @awarizon/reactRecommended

React + ViteSPA + @awarizon/reactLightweight

Expo (React Native)@awarizon/react-native + KeychainMobile

Flags — skip the prompts

Pass any combination of flags to run non-interactively. Useful for CI scripts, dotfiles, or when you already know what you want.

FULL NON-INTERACTIVE EXAMPLE

$npx create-awarizon-app my-app --template nextjs --lang ts --api-key awz_live_...

FLAGS

[project-name]stringDirectory to create. Prompted interactively when omitted.

--template / -tnextjs | react | expoApp template. Prompted interactively when omitted.

--lang / -lts | jsOutput language. Default: ts. (Expo is always TypeScript.)

--api-key / -kstringAwarizon API key — baked into .env automatically. Can be added later.

--pmnpm | pnpm | yarn | bunPackage manager for installing dependencies. Auto-detected from env when omitted.

--skip-installflagCopy files only — skip running the install command.

Common examples

Next.js — TypeScript (default)

$npx create-awarizon-app my-dapp --template nextjs

React + Vite — JavaScript

$npx create-awarizon-app my-dapp --template react --lang js

Expo — mobile wallet app

$npx create-awarizon-app my-wallet --template expo

pnpm + skip install (faster in CI)

$npx create-awarizon-app my-dapp --template nextjs --pm pnpm --skip-install

What gets scaffolded

Every template ships with the SDK already configured — no copy-pasting boilerplate.

SDK instancelib/awarizon.ts — created once, exported everywhere

Provider wiredAwarizonProvider wrapping the root layout

ConnectButtonDrop-in wallet UI component in the home page

.env pre-filledAPI key baked in if you passed --api-key

TypeScript / JSDocFull types on TS templates, JSDoc hints on JS

Deps installednpm install runs automatically (unless --skip-install)

💡

After scaffolding, open .env.local (Next.js) or .env (React / Expo) and paste your API key if you skipped the --api-key flag. Keys are free at awarizon.com/dashboard/api-keys.

←

Installation

Setup Guide

→