Jump to content

Installation

To scaffold an Aztec dapp using create-aztec-dapp, run any of the following commands and answer the command prompt questions:

npm

npm create aztec-dapp@latest

yarn

yarn create aztec-dapp

pnpm

pnpm create aztec-dapp@latest

bun

bun create aztec-dapp@latest

About Create Aztec Dapp

Create Aztec Dapp is a CLI tool that helps you quickly set up a new Aztec decentralized application with all the best practices and configuration ready to go. It provides:

  • React templates for building your frontend
  • Aztec SDK integration for interacting with the protocol
  • Tailwind CSS support for styling
  • TypeScript for type safety
  • Aztec Sandbox for local development

CLI Options

Option/FlagDescription
[dir]Include a directory argument with a name for the project
--noGitExplicitly tell the CLI to not initialize a new git repo in the project
-y, --defaultBypass the CLI and bootstrap a new dapp with all options selected
--noInstallGenerate project without installing dependencies

Getting Started

Once your project is created:

  1. Navigate to your project directory:

    cd your-project-name
  2. Start the development server:

    npm run dev
  3. Open your browser and navigate to http://localhost:3000 to see your new Aztec dapp!

Next Steps

After installing your Aztec dapp, you can:

  1. Explore the project structure
  2. Check out the Aztec SDK documentation
  3. Begin building your zero-knowledge application logic
  4. Deploy your contracts to an Aztec network