Skip to main content

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 (default Greeting (React) template), or continue with this guide to create and run a new project locally.

1. Install system requirements​

2. Scaffold a new app​

Option 1. Use the Github template​

  1. Create a new project from the template.

  2. Clone the resulting repo locally.

  3. Choose a template by running the corresponding init command:

TemplateInit command
Greeting (React)pnpm init:template:greeting-react
Greeting (Next.js)pnpm init:template:greeting-next
Counter (React)pnpm init:template:counter-react

Template Guide

Option 2. Use CLI​

pnpm create sui-dapp@latest

This way you'll be able to choose a template and configure the project step-by-step.

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​

Use the faucet button integrated into your wallet (e.g. Sui Wallet).

8. Run the app​

pnpm start

You can find all starter console commands in package.json