ZUNI DAPP TEMPLATE

This repo helps you start the dapp faster.

Overview

Table of contents

• Project Structure
• Features
• Deployment
• Getting Started
  • Prerequisites
  • Installation
• UI
  • Project commands
• Contract
  • Development
  • Testing
• Contributing
• License

Project Structure

zuni-your-app/
│
├── contract/
│   ├── src/
│   │   ├── interfaces/
│   │   │   ├── Interface.sol
│   │   ├── libraries/
│   │   │   ├── Lib.sol
│   │   ├── Common.sol
│   ├── scripts/
│
├── ui/
│   ├── app/
│   ├── components/
│   │   ├── shadcn
│   │   ├── ...
│   │
│   ├── constants/
│   ├── hooks/
│   ├── public/
│   ├── stats/
│   ├── types
│   ├── utils/
│   ├── package.json
│   ├── tsconfig.json
│   ├── ...
│
├── README.md
└── package.json

Features

UI Features

Smart Contract Features

Deployment

Website

Smart contract addresses

• Network: ABC, XYZ

  Contract	Address
  Contract A	0x123
  Contract B	0x456

Getting Started

Prerequisites

• Node.js v21
• Bun

Installation

1. Clone the repo

2. Copy .env.example to .env:

   cp .env.example .env

3. Example:

UI

Project commands

• Run: bun install for install all packages
• Run: bun dev for start dev environment
• Run: bun build for build your project
• Run: bun start for start your built project
• Run: bun lint for checking error and fix it

Contract

Testing

Contributing

We welcome contributions! Please follow these steps to contribute:

• Fork the repository
• Create a new branch (git checkout -b feature-branch)
• Make your changes
• Commit your changes (git commit -m 'Add some feature')
• Push to the branch (git push origin feature-branch)
• Create a new Pull Request

License