Get started guides with AppKit
To scaffold a working app in one command, run npm create ton-appkit. For details, see Quick start.
Follow the other guides in this section if you want to understand how the generated project works, or if you're integrating AppKit into an existing project manually.
Each page is one concrete action.
Minimum implementation
Complete the first five steps to implement the minimum functional app:
| Step | What you do |
|---|---|
| Prepare your project | Scaffold a project if you have none, install AppKit, and add the Buffer polyfill. |
| Add wallet connectors | Create the AppKit instance and drop in <TonConnectButton />. |
| Add networks | Configure mainnet alongside testnet and pick an API client. |
| Use basic getter hooks | Read wallet, address, balance, jetton, NFT, network, and transaction state. |
| Send transactions | Send Gram, jettons, NFTs, or prepared transactions. |
Additional functionality
The remaining pages are improvements that layer on live updates, DeFi flows, and ready-made UI:
| Step | What you do |
|---|---|
| Stream live updates | Subscribe to balance, jetton, and transaction changes in real time. |
| Add DeFi providers | Plug in swap and staking providers when the app needs DeFi flows. |
| Use UI widgets | Drop in <SwapWidget />, <StakingWidget />, and other prebuilt flows. |
AI coding assistance
You can install the AppKit skill for your AI coding assistant:
npx skills add ton-org/kit/packages/appkit/skills/ton-appkitAfter installation, the assistant gives AppKit-specific answers about hooks, patterns, and common pitfalls.
Next steps
- Scaffold a working app in one command with Quick start.
- After that, go to How-to guides for task-level recipes, or explore the other guides in Get started to understand how the generated project works.
- Look up types and signatures in Reference.