aptos-labs / create-aptos-dapp

Create Aptos Dapp

create-aptos-dapp provides a starter kit for dapp developers to easily bootstrap on the Aptos network

NOTE: No need to clone: run npx create-aptos-dapp in your terminal to get started

Quick Start

To create a Aptos dapp, open your terminal, cd into the directory you’d like to create the dapp in, and run the following command:

npx create-aptos-dapp

Then follow the prompts!

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Prerequisites

• node and npm (npm ≥ 5.2.0)

What is create-aptos-dapp?

create-aptos-dapp simplifies the initial setup and configuration process, provides a modern development workflow, gives pre-made e2e dapp templates, and offers a range of benefits that save time and effort. Using create-aptos-dapp enables developers to build dapps quicker on Aptos.

Why use create-aptos-dapp?

• Template 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.
• Dependencies Management: create-aptos-dapp manages project dependencies for you. It generates a npm (or pnpm, etc.) package with the required packages. This ensures that the libraries used by your project are compatible.
• Move Directory: create-aptos-dapp generates a move directory that includes the basic structure for Move modules (smart contracts). Additionally, it adds a basic Move module and associated files.
• Best Practices: create-aptos-dapp incorporates best practices and structure recommendations to develop for the Aptos network. This ensures that your project starts with a solid foundation.
• 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. This abstracts Move development workflows for the average dapp developer.

Templates

create-aptos-dapp provides you with pre-made 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.

• Digital Asset Template: A minting NFT dapp
• Fungible Asset Template: A minting fungible asset dapp

create-aptos-dapp's Issues

npm run move:init Command Failure on Windows

When attempting to run the npm run move:init command in the my-aptos-dapp directory following the setup instructions, an error occurs related to the export command. This error prevents the initialization process for the CLI Profile.

Observe the error: 'export' is not recognized as an internal or external command, operable program or batch file.

List a package manager as a prereq and exit the flow if yarn/npm/pnpm fails

The wizard chugs on and tells you Success! You're ready to start building your dapp on Aptos.

Update the readme to say that you need a package manager installed

The wizard should exit with an error.

inconsistent names between create-aptos-dapp and create-apt-dapp

in the repo level it is called create-aptos-dapp, while in the npm level it is called create-apt-dapp.

would be great if you can consolidate the 2 names into just 1 to make it easy to refer and search

Support back/next option on wizard flow

When starting the wizard and follow each step, there is no way to go back and/or forward to a step.

Add back/next option to previous/next step and respect any choice changes.

Support confirmation prompt at the end of the Wizard Flow

Add a confirmation prompt at the end of the wizard that allows users to change their inputs before building the project.

Example:

Project name: 'fakeName',
Choose how to start: 'Toollist Dapp',
Choose network: 'Devnet',
Choose your package manager: 'npm',

Do you wish to change anything? Yes | No. 

What do you wish to edit? "ProjectName" | "Start" | "Network" | "packageManager"

Hey @0xmaayan I will lay out exactly how I plan on implementing this in a few hours after my work and you can check it out before I actually add it to the codebase.

One thing before I start, how do I test this locally? I am unfamiliar with these terminal prompts and the readme only explains how to run the deployed npm prompt.