# Supra Dapp Templates

Welcome to [@supranpm/supra-dapp-templates](https://www.npmjs.com/package/@supranpm/supra-dapp-templates), your go-to starter kit for dapp development on the Supra network. This npm package allows developers to bootstrap their dapps with ease and efficiency.

## Prerequisites

Before getting started, ensure the following:

* [Node.js and npm](https://nodejs.org/en) installed.
* [Python 3.6+](https://www.python.org/) installed.

## How to use:

Follow these steps to create your dapp:

{% stepper %}
{% step %}

#### Navigate to your desired directory:

```sh
cd your/workspace
```

{% endstep %}

{% step %}

#### Run the following command:

```sh
npx @supranpm/supra-dapp-templates
```

{% endstep %}

{% step %}

#### Follow the CLI prompts:

* Name your project.
* Choose a template.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmTBWRilfF5GuWWSNVrjY%2Fuploads%2F9fjzWge44gxJJvel70Kd%2FRecording%202025-06-14%20171305.mp4?alt=media&token=e5d34854-2ff6-4e75-bda1-9911bcf492b1>" %}
{% endstep %}
{% endstepper %}

## Running Your Project:

After you've selected your template and completed the setup, here’s how you can execute and run your project <kbd>assuming</kbd> you have used **Supra StarKey Wallet Dapp Template**:

{% stepper %}
{% step %}

#### Navigate to your project directory.

```bash
cd your/project-name
```

{% endstep %}

{% step %}

#### Build & Run the Frontend of the Dapp.

```bash
npm run build
npm start
```

{% endstep %}

{% step %}
And your project should be up and running! Connect to your Starkey Wallet
{% endstep %}
{% endstepper %}

### Templates Available in the Package:

`npx @supranpm/supra-dapp-templates` offers multiple templates to accelerate dapp development:<br>

* **Basic Smart Contract Template:** Boilerplate smart contract for quick access.<br>
* **Supra SDK Dapp Template:** Sample Supra SDK with StarKey Wallet integration for building a to-do list dApp and Frontend Integration.<br>
* **Supra StarKey Wallet Dapp Template:** A Spin the Wheel dapp built on Supra MoveVM Testnet with Supra\_framework, StarKey Wallet & Frontend Integration<br>
* **Supra dVRF Template**: Template to get Started with Dapp on Supra dVRF on Supra MoveVM.<br>
* **Supra Automation Template**: Template to get your first Supra Automation Task Registered for Auto Wallet Top-up Usecase.<br>
* **Supra Push Oracles Template:** Template to integrate Supra's push oracle data feeds in Move smart contracts on Supra Move.

## Contribution:

We welcome contributions to enhance the functionality, add more dapp templates, or improve the user experience of this package. Here’s how you can contribute:

* Fork the main repository on GitHub.

{% embed url="<https://github.com/Supra-Labs/supra-dapp-templates>" %}

* Clone the forked repository to your local machine.
* Make your changes and push them.
* Submit a pull request to the main repository.