make-osm-aptos-dapp
v1.0.0
Published
a starter kit for dapp developers to easily bootstrap a dapp on the Aptos network
Downloads
3
Maintainers
Readme
Create Apt Dapp
create-apt-dapp
provides a starter kit for dapp developers to easily bootstrap a dapp on the Aptos network.
NOTE: No need to clone: run
npx create-apt-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-apt-dapp
Then follow the prompts!
(npx comes with npm 5.2+ and higher, see instructions for older npm versions)
What is create-apt-dapp?
create-apt-dapp
simplifies the initial setup and configuration process, provides a modern development workflow, and offers a range of benefits that save time and effort, enabling developers to focus on building dapps on Aptos effectively.
create-apt-dapp
streamlines the initial setup of a dapp development project, provides a solid foundation, and allows developers to start coding quickly without getting bogged down by configuration and boilerplate code
Why use create-apt-dapp?
- Boilerplate Setup:
create-apt-dapp
tool generates a predefined project structure and configuration files for you. This saves you from manually setting up the basic project structure, which can be time-consuming and error-prone. - Dependencies Management:
create-apt-dapp
tool manages project dependencies for you. It generates apackage.json
file with the required packages and their versions, ensuring that your project uses compatible libraries. - Move Folder:
create-apt-dapp
generates amove
folder that includes the basic structure for move modules. It creates aMove.toml
andsources
folder with a move module (smart contract) in it. - Best Practices:
create-apt-dapp
tool incorporates best practices and structure recommendations to develop for the Aptos network. This ensures that your project starts with a solid foundation. - Built-in Scripts:
create-apt-dapp
tool includes built-in scripts for common tasks like initialize default profile, compile move module and publish smart contract to chain. This simplifies common development workflows.
Prerequisites
- node and npm (npm ≥ 5.2.0)
Templates
create-apt-dapp
generates a predefined template structure and configuration files for you
- web dapp boilerplate: A simple and light-weight web based dapp template that includes the basic structure needed for starting a dapp
- node dapp boilerplate: A simple and light-weight node template that includes the basic structure needed for starting a node project on Aptos.
- todolist dapp boilerplate: A fully working todo list dapp with a pre-implemented smart contract and UI