Quick Start
Sui dApp Starter is a full-stack boilerplate which let's you scaffold a solid foundation for your Sui project and focus on the business logic of your dapp from day one.
Here you can find a step-by-step guide on how to get up and running with Sui dApp Starter locally.
If you want to try Sui dApp Starter right away, check out our demo, or continue with this guide to create and run a new project locally.
1. Install system requirements
- Sui prerequisites (Sui prerequisites only)
- Suibase
- Docker
- Node (>= 20)
- pnpm (>= 9)
2. Scaffold a new app
or
pnpm create sui-dapp@latest
3. Install project dependencies
pnpm install
4. Run the local Sui network
pnpm localnet:start
Local Sui Explorer will be available on localhost:9001
5. Deploy the demo package to the local network
pnpm localnet:deploy
6. Switch your wallet to the local network
Go to your browser wallet settings and find the Network setting, where choose Local.
7. Fund your local network account/address
- Wallet
- Console
- App
Use the faucet button integrated into your wallet (e.g. Sui Wallet).
Copy your localnet address from your wallet and pass it to the command as a parameter:
pnpm localnet:faucet 0xYOURADDRESS
Run the app and use the Faucet button, located in the footer.
8. Run the app
pnpm start
You can find all starter console commands in package.json