Quickstart
This guide walks you through creating your first dApp with web3market-kit, from project scaffolding to local development.
Create a new project
The fastest way to start is with a template:
w3m new my-token --template token-standardAvailable templates:
| Template | Description |
|---|---|
token-standard | Standard ERC-20 token (mintable, burnable) |
token-tax | Tax token with buy/sell tax and max wallet |
token-meme | Meme token with trading controls and burn |
token-reflection | Reflection token with holder rewards |
The template prompts for parameters (token name, symbol, initial supply, etc.), then scaffolds the full project with contracts, tests, deployment scripts, and a Next.js frontend.
After scaffolding, you see an honest summary of what succeeded:
┌ my-token is ready ─────────────────────────────────╮
│ │
│ ✓ 28 files generated │
│ ✓ Dependencies installed │
│ ✓ Solidity deps installed │
│ ✓ Codegen complete │
│ │
├──────────────────────────────────────────────────────╯No authentication is needed to create projects. Everything works locally for free.
Start the dev environment
For token projects (which include a frontend), select Start dev environment from the post-scaffold menu, or run:
cd my-token
w3m devThis single command:
- Starts a local Anvil chain on
http://127.0.0.1:8545 - Compiles contracts with
forge build - Deploys contracts to the local chain
- Runs codegen to generate TypeScript bindings
- Starts the Next.js dev server at
http://localhost:3000
Press Ctrl+C to stop everything.
Use the interactive workspace
w3mRunning w3m with no arguments opens the interactive workspace. Inside a project directory, it shows the project menu:
| Option | Description |
|---|---|
| Dev environment | Local chain + frontend |
| Deploy | Pick a chain (Local, testnet, mainnet) |
| AI customize | Modify contracts & frontend (single-shot) |
| AI Chat | Interactive multi-turn AI conversation |
| Auto-fix | Diagnose & repair build errors with AI |
| Test | Forge test suite |
| Audit | Security analysis |
| Switch project | Open a different project |
The workspace stays open in a loop — commands run inline and return to the menu.
Run tests
w3m testRuns forge test on your Solidity contracts. Use --verbose for detailed output.
Deploy locally from the workspace
From the workspace menu, select Deploy > Local (Anvil). This starts Anvil, builds, deploys, and shows a deployment summary — no authentication required.
Deploy to a testnet (requires auth)
When you’re ready to deploy to a live network:
w3m deploy --chain sepoliaBefore deploying, set the required environment variables in a .env file:
SEPOLIA_RPC_URL=https://eth-sepolia.g.alchemy.com/v2/YOUR_KEY
DEPLOYER_PRIVATE_KEY=0xYOUR_PRIVATE_KEYAnd authenticate:
w3m auth wm_sk_live_your_key_hereNever commit your .env file or private keys to version control.
Additional deploy options:
w3m deploy --chain sepolia --verify # Verify contracts on Etherscan
w3m deploy --chain sepolia --vercel # Deploy frontend to Vercel
w3m deploy --chain sepolia --skip-tests # Skip test suiteInteractive Setup (Alternative)
If you prefer to customize everything, run w3m new without a template:
w3m newThis walks you through choosing a contract framework, frontend framework, components, chains, and package manager.
What Next?
- Learn about the Project Structure in detail
- Explore available Modules
- Read the full CLI Reference for all commands and options
- Configure your project with kit.config.ts