Skip to content

Commit 0c3eeae

Browse files
committed
chore: readme fixes and demo link for web3auth
1 parent 4c2d097 commit 0c3eeae

File tree

1 file changed

+40
-58
lines changed

1 file changed

+40
-58
lines changed

README.md

Lines changed: 40 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ A TypeScript SDK toolkit for building Dapps on Polkadot Cloud - inspired by Hard
44

55
## Features
66

7-
🚀 **Quick Project Setup** - Initialize Polkadot Dapp projects in seconds with `kitdot install`
8-
🎨 **React + Solidity Templates** - Production-ready templates with Vite, Tailwind CSS, and wagmi
9-
⚙️ **Smart Contracts** - Hardhat setup for Solidity development on Polkadot Asset Hub
10-
📋 **AI Development Guide** - Integrated AGENTS.md for LLM-assisted development
11-
🔧 **Developer Tools** - Rust toolchain management and status checking
12-
🌐 **Polkadot Integration** - Pre-configured for Paseo testnet with proper network settings
7+
- 🚀 **Quick Project Setup** - Initialize Polkadot Dapp projects in seconds with `kitdot install`
8+
- 🔐 **Web3Auth Social Logins** - Seamless user onboarding with Google, GitHub, Discord, Twitter, and more. [Try the live demo →](https://kitdot-fronted-templates.w3d.community/quick-starts/react-quick-start/)
9+
- 🎨 **React Templates** - Production-ready templates with Vite, Tailwind CSS, and wagmi
10+
- ⚙️ **Smart Contracts** - Hardhat setup for Solidity development on Polkadot Asset Hub
11+
- 📋 **AI Development Guide** - Integrated AGENTS.md for LLM-assisted development
12+
- 🔧 **Developer Tools** - Rust toolchain management and status checking
13+
- 🌐 **Polkadot Integration** - Pre-configured for Paseo testnet with proper network settings
1314

1415
## Installation
1516

@@ -33,36 +34,38 @@ npx kitdot init my-polkadot-dapp
3334

3435
## Quick Start
3536

36-
# Quick start with default template
37+
### Recommended: Use Web3Auth Default Templates for Best User Experience
3738

39+
```bash
3840
kitdot install -y my-app
39-
4041
```
4142

43+
**✨ Live Demo:** [https://kitdot-fronted-templates.w3d.community/quick-starts/react-quick-start/](https://kitdot-fronted-templates.w3d.community/quick-starts/react-quick-start/)
44+
45+
**Why Web3Auth?** No seed phrases, no private key management - users log in with Google, GitHub, or other social accounts they already use.
46+
4247
The CLI will guide you through setting up:
4348

44-
- **Full-stack Dapp** - React frontend + Solidity contracts + Hardhat
45-
- **Frontend only** - React app with wagmi for Polkadot interaction
49+
- **Frontend only** - React app with Web3Auth social logins + wagmi for Polkadot interaction
50+
- **Full-stack Dapp** - React frontend with Web3Auth + Solidity contracts + Hardhat
4651
- **Backend only** - Smart contracts with Hardhat development environment
4752

4853
## Project Structure
4954

5055
```
51-
5256
my-polkadot-dapp/
53-
├── contracts/ # Hardhat smart contracts (Solidity)
54-
│ ├── contracts/ # Smart contract source files
55-
│ ├── ignition/ # Hardhat Ignition deployment modules
56-
│ ├── test/ # Contract tests
57-
│ └── hardhat.config.ts # Hardhat configuration for Polkadot
58-
├── frontend/ # React frontend with Polkadot integration
59-
│ ├── src/ # React TypeScript source
60-
│ ├── src/generated.ts # Auto-generated contract types
61-
│ └── wagmi.config.ts # wagmi configuration for Polkadot
62-
├── AGENTS.md # AI development guide for LLMs
63-
└── README.md # Project-specific documentation
64-
65-
````
57+
├── contracts/ # Hardhat smart contracts (Solidity)
58+
│ ├── contracts/ # Smart contract source files
59+
│ ├── ignition/ # Hardhat Ignition deployment modules
60+
│ ├── test/ # Contract tests
61+
│ └── hardhat.config.ts # Hardhat configuration for Polkadot
62+
├── frontend/ # React frontend with Polkadot integration
63+
│ ├── src/ # React TypeScript source
64+
│ ├── src/generated.ts # Auto-generated contract types
65+
│ └── wagmi.config.ts # wagmi configuration for Polkadot
66+
├── AGENTS.md # AI development guide for LLMs
67+
└── README.md # Project-specific documentation
68+
```
6669

6770
## Commands
6871

@@ -79,7 +82,7 @@ kitdot tools check # Check tool status
7982
# Help
8083
kitdot --help # Show all available commands
8184
kitdot init --help # Show specific command help
82-
````
85+
```
8386

8487
> **Note**: Replace `kitdot` with `npx kitdot` if you haven't installed globally.
8588
@@ -111,38 +114,21 @@ npm run generate # Generate contract types from deployed c
111114
npm run dev # Start development server
112115
```
113116

114-
### 4. Environment Setup
115-
116-
```bash
117-
# Set up private key for contract deployment
118-
npx hardhat vars set PRIVATE_KEY # In contracts directory
119-
120-
# Get testnet tokens
121-
# Visit: https://faucet.polkadot.io/?parachain=1111
122-
```
123-
124-
## Technology Stack
125-
126-
### Smart Contracts
127-
128-
- **Hardhat** - Development environment with Polkadot support via `@parity/hardhat-polkadot`
129-
- **Solidity ^0.8.28** - Smart contract programming language (required version)
130-
- **Hardhat Ignition** - Modern deployment system with dependency management
131-
- **Polkadot Asset Hub** - Target network for smart contract deployment
132-
133-
### Frontend
134-
135-
- **React 18** - Modern UI library with TypeScript
136-
- **wagmi** - React hooks for Ethereum/Polkadot contract interaction
137-
- **Viem** - TypeScript interface for Ethereum-compatible chains
138-
- **Tailwind CSS** - Utility-first CSS framework with Tailwind UI components
139-
- **Vite** - Fast build tool and development server
140-
141117
## Templates
142118

143119
kitdot includes production-ready templates:
144120

145-
### Default Template
121+
### ⭐ Recommended: React + Web3Auth (Frontend Only)
122+
123+
- **Social Login Integration** - [Live Demo](https://kitdot-fronted-templates.w3d.community/quick-starts/react-quick-start/)
124+
- **Web3Auth** for seamless social logins (Google, GitHub, Discord, Twitter, etc.)
125+
- No seed phrases or private key management for users
126+
- React 18 frontend with TypeScript and Tailwind CSS
127+
- wagmi hooks for Polkadot interaction
128+
- Pre-configured for Paseo testnet
129+
- Modern, production-ready UX with social authentication
130+
131+
### Full-stack Template
146132

147133
- **React + Solidity + Hardhat** - Full-stack template with:
148134
- React 18 frontend with TypeScript and Tailwind CSS
@@ -159,8 +145,4 @@ kitdot includes production-ready templates:
159145
- Network configurations and deployment instructions
160146
- Security patterns and best practices
161147
- Troubleshooting checklists and common solutions
162-
- Recommended development workflows
163-
164-
## License
165-
166-
MIT License - see [LICENSE](LICENSE) for details.
148+
- Recommended development workflows

0 commit comments

Comments
 (0)