create-osm-apt v0.0.14

Create OSM APT

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

NOTE: No need to clone: run npx create-osm-apt 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-osm-apt

Then follow the prompts!

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

What is create-osm-apt?

create-osm-apt 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-osm-apt 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-osm-apt?

• Boilerplate Setup: create-osm-apt 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-osm-apt tool manages project dependencies for you. It generates a package.json file with the required packages and their versions, ensuring that your project uses compatible libraries.
• Move Folder: create-osm-apt generates a move folder that includes the basic structure for move modules. It creates a Move.toml and sources folder with a move module (smart contract) in it.
• Best Practices: create-osm-apt 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-osm-apt 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-osm-apt generates a predefined template structure and configuration files for you

• calculation-boilerplate: Boilerplate for a dapp involving calculation functionalities.
• firstnft-boilerplate: Boilerplate for creating your first Non-Fungible Token (NFT) dapp.
• firsttoken-boilerplate: Boilerplate for creating your first token-based dapp.
• firsttrxn-boilerplate: Boilerplate for a dapp involving initial transactions.
• game-boilerplate: Boilerplate for developing a game-based dapp.
• hello-boilerplate: A basic hello world boilerplate for getting started with dapp development.
• marketplace-boilerplate: Boilerplate for creating a decentralized marketplace dapp.
• todolist-boilerplate: Similar to the existing to-do list dapp boilerplate but with potential enhancements or variations.