create-aptos-dapp

0.0.36 • Public • Published

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@latest 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@latest

Then follow the prompts!

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

Prerequisites

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.

  • Boilerplate Template: A minimal dapp that has an empty contract and a UI that only connects to wallet
  • Digital Asset Template: A minting NFT dapp
  • Fungible Asset Template: A minting fungible asset dapp

Examples

create-aptos-dapp also provides you with full stack examples that are for educational purpose, these examples are not production ready and not audited.

  • Aptos Friend Template: A friend tech style social app that implements share trading

Releasing a new version

Bump the version in package.json and update CHANGELOG.md.

Run this to cleanup and rebuild project:

npm run build

Run this to preview the change and make sure it aligns with the existing published package:

npm publish --dry-run

Run this to publish the new version:

npm publish

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
0.0.3680latest

Version History

VersionDownloads (Last 7 Days)Published
0.0.3680
0.0.3536
0.0.347
0.0.331
0.0.321
0.0.311
0.0.301
0.0.291
0.0.281
0.0.271
0.0.261
0.0.251
0.0.241
0.0.231
0.0.222
0.0.211
0.0.201
0.0.191
0.0.181
0.0.171
0.0.161
0.0.151
0.0.141
0.0.131
0.0.121
0.0.111
0.0.101
0.0.91
0.0.81
0.0.71
0.0.61
0.0.51
0.0.41
0.0.31
0.0.22
0.0.11

Package Sidebar

Install

npm i create-aptos-dapp

Weekly Downloads

158

Version

0.0.36

License

Apache-2.0

Unpacked Size

1.81 MB

Total Files

860

Last publish

Collaborators

  • aptos-labs