The custom indexer template provides a starter dapp with all components to run a full-stack app with indexer support.
To get started with the Custom Indexer template and learn more about the template functionality and usage, head over to the Custom Indexer template docs
- Folder structure - A pre-made dapp folder structure with
srcfor frontend,contractfor Move contract andindexerfor custom indexer. - Dapp infrastructure - All required dependencies a dapp needs to start building on the Aptos network.
- Wallet Info implementation - Pre-made
WalletInfocomponents to demonstrate how one can use to read a connected Wallet info. - Message board functionality implementation - Pre-made
MessageBoardcomponent to create, update and read messages from the Move smart contract. - Analytics dashboard - Pre-made
Analyticscomponent to show the number of messages created and updated. - Point program - Minimal example to show you how to define a point program based on events (e.g. create message, update message) and show that on the analytics dashboard, with sorting support.
- React framework
- shadcn/ui + tailwind for styling
- Aptos TS SDK
- Aptos Wallet Adapter
- Node based Move commands
- Rust based Aptos Indexer SDK
The tool utilizes aptos-cli npm package that lets us run Aptos CLI in a Node environment.
Some commands are built-in the template and can be ran as a npm script, for example:
npm run move:publish- a command to publish the Move contractnpm run move:test- a command to run Move unit testsnpm run move:compile- a command to compile the Move contractnpm run move:upgrade- a command to upgrade the Move contractnpm run dev- a command to run the frontend locallynpm run deploy- a command to deploy the dapp to Vercel
For all other available CLI commands, can run npx aptos and see a list of all available commands.
Please refer to the Custom Indexer template docs for more information on how to run the Custom Indexer template.