@eveworld/create-eve-dapp 🚀

The @eveworld/create-eve-dapp package is a command-line tool that helps you scaffold a new decentralized application (dApp) project, specifically designed for the EVE Frontier ecosystem. You can choose between a Smart Assembly Base or a DApp Scaffold to kickstart your development.

✨ Features

• 🏗️ Smart Assembly Base: Easily customize and extend the Smart Assembly.
• 🖼️ DApp Scaffold: Build your custom dApp from scratch.
• ⚡ Built with Vite, Material UI, TailwindCSS, React Router, and Viem for modern, fast, and flexible development.

📖 Table of Contents

1. Prerequisites
2. Quick Start
   • 1. Initialize a New DApp
   • 2. Navigate to the Project Directory
   • 3. Install Dependencies
   • 4. Set Up Environment Variables
   • 5. Run the Development Server
   • 6. Build for Production
3. Development Options
4. License

⚙️ Prerequisites

Before starting, make sure you have the following installed:

• 📦 pnpm v8: Install with npm install --global pnpm@8
• 🖥️ Node.js v18+: Use nvm use 18 to switch to Node v18 or later.

Important: Ensure you are using pnpm v8 to avoid any package resolution issues during installation.

🚀 Quick Start

1. Initialize a New DApp

Run this command to scaffold a new dApp:

npx @eveworld/create-eve-dapp my-dapp

Alternatively, to create a DApp Scaffold:

npx @eveworld/create-eve-dapp --type scaffold my-dapp

2. Navigate to the Project Directory

cd my-dapp

3. Install Dependencies

Install all the required dependencies using pnpm:

pnpm install

4. Set Up Environment Variables

Clone the provided .envsample file to create a local .env file:

cp .envsample .env

Then, configure the following environment variables in your .env file:

VITE_SMARTASSEMBLY_ID=
VITE_GATEWAY_HTTP="https://blockchain-gateway-nebula.nursery.reitnorf.com"
VITE_GATEWAY_WS="wss://blockchain-gateway-nebula.nursery.reitnorf.com"

This setup will allow your dApp to connect to the specified blockchain indexer.

5. Run the Development Server

To start the development server, run:

pnpm run dev

Open http://localhost:3000 in your browser to view your dApp.

6. Build for Production

When you're ready to deploy your dApp, generate a production-ready bundle:

pnpm run build

Or, to specify production mode explicitly:

pnpm run build --mode prod

🛠️ Development Options

You have two main options when using this tool:

1. Customize the Smart Assembly Base for your project.
2. Start fresh with a DApp Scaffold to build your dApp from scratch.

To get started with either option:

npx @eveworld/create-eve-dapp my-dapp

Or, for a scaffolded dApp:

npx @eveworld/create-eve-dapp --type scaffold my-dapp

Then follow these steps:

cd my-dapp
pnpm install
pnpm run dev

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.