create-aptos-dapp
create-aptos-dapp
builds a template project for dapp developers to easily create a front-end and a smart contract on the Aptos network.
Why use create-aptos-dapp?
- Templated Setup:
create-aptos-dapp
generates predefined end-to-end dapp templates and configuration files for you. It saves manual setup of the project structure, which can be time-consuming and error-prone. - Contract Directory:
create-aptos-dapp
generates acontract
directory that includes the basic structure for Move smart contract modules. - Best Practices:
create-aptos-dapp
incorporates best practices and structure recommendations to develop for the Aptos network. - Built-in Move Commands:
create-aptos-dapp
includes built-in commands for common tasks, such as initializing the Move compiler, compiling, and publishing smart contracts on-chain.
Prerequisites
- node and npm (npm ≥ 5.2.0)
- Python 3.6+
Using create-aptos-dapp
Navigate to the directory you want to work in.
Terminal
cd your/workspace
Install create-aptos-dapp
.
Terminal
npx create-aptos-dapp@latest
Follow the CLI prompts.
After installing, you will need to answer several questions about your project including:
- The project’s name
- Which template to use (see below)
- Whether to use Mainnet or Devnet for testing
Templates
create-aptos-dapp
provides you with premade end-to-end dapp templates, i.e. a ready dapp with configurations and a beautiful UI to get you started with creating a dapp on Aptos.
The goals of the templates are to:
- Familiarize users with different Aptos Standards by having an end-to-end dapp template examples.
- Educate users on how to build a dapp on Aptos from the front-end layer to the smart contract layer and how everything in-between.
- Provide users with pre-made templates to quickly deploy simple dapps
Current Templates
All current templates are available on Aptos Learn. Read more about specific templates below:
- Boilerplate Template
- Telegram Mini app Template
- NFT minting dapp Template
- Token minting dapp Template
- Token staking dapp Template
- Custom indexer template
Tools create-aptos-dapp
utilizes
- React framework
- Vite development tool
- shadcn/ui + tailwind for styling
- Aptos TS SDK
- Aptos Wallet Adapter
- Node based Move commands