Skip to content

Commit d5ba230

Browse files
committed
docs: overhaul README with comprehensive tutorial structure, learning objectives, and technology stack details
1 parent 511bc57 commit d5ba230

File tree

1 file changed

+188
-2
lines changed

1 file changed

+188
-2
lines changed

README.md

Lines changed: 188 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,193 @@
33
</br>
44
Nimiq Tutorial
55
</h1>
6+
67
<p align="center">
7-
Learn how to use the Nimiq Web Client to build awesome apps on top of the <b>Nimiq blockchain</b>.
8+
<strong>Learn how to build decentralized applications with the Nimiq blockchain using the Web Client</strong>
9+
</p>
10+
11+
<p align="center">
12+
<em>No downloads, no installations - just JavaScript that connects directly to the blockchain!</em>
13+
</p>
14+
15+
---
16+
17+
## 🌟 What Makes This Tutorial Special?
18+
19+
- **🔥 Zero Setup Required**: Everything runs in your browser using WebContainer
20+
- **📚 Beginner-Friendly**: No prior blockchain experience needed
21+
- **🧪 Hands-On Learning**: Try code examples immediately
22+
- **🌐 Real Blockchain Interaction**: Connect to the actual Nimiq testnet and mainnet
23+
- **⚡ Interactive Environment**: Complete file system with terminal access
24+
25+
## 📖 What You'll Learn
26+
27+
By the end of this tutorial, you'll master:
28+
29+
-**Network Connection**: Connect to Nimiq and read blockchain data
30+
-**Wallet Management**: Create wallets and generate addresses
31+
-**Transaction Handling**: Send payments and manage funds
32+
-**Staking Operations**: Delegate tokens and earn rewards
33+
-**Advanced Features**: Work with HTLCs, cashlinks, and more
34+
35+
## 🗺️ Tutorial Structure
36+
37+
### 🎯 **0. Introduction**
38+
39+
- Welcome to Nimiq and blockchain development
40+
- Understanding the Web Client architecture
41+
- Setting up your development environment
42+
43+
### 🔌 **1. Connecting to Network**
44+
45+
- Establishing connection to Nimiq network
46+
- Exploring blockchain data and consensus
47+
- Understanding network synchronization
48+
49+
### 💰 **2. Working with Transactions**
50+
51+
- Creating and managing wallets
52+
- Requesting testnet funds from faucet
53+
- Signing and sending transactions
54+
55+
### 🏆 **3. Staking and Validators**
56+
57+
- Understanding Proof-of-Stake consensus
58+
- Exploring validator ecosystem
59+
- Implementing staking operations
60+
61+
### 🔧 **4. Miscellaneous Features**
62+
63+
- Advanced Web Client capabilities
64+
- Best practices and optimization
65+
- Real-world application patterns
66+
67+
## 🚀 Getting Started
68+
69+
### Prerequisites
70+
71+
- Node.js (v18 or higher)
72+
- pnpm (recommended) or npm
73+
- Modern web browser
74+
75+
### Installation
76+
77+
```bash
78+
# Clone the repository
79+
git clone https://github.com/onmax/nimiq-tutorial.git
80+
cd nimiq-tutorial
81+
82+
# Install dependencies
83+
pnpm install
84+
85+
# Start development server
86+
pnpm dev
87+
```
88+
89+
### Development Commands
90+
91+
```bash
92+
# Start development server
93+
pnpm dev
94+
95+
# Build for production
96+
pnpm build
97+
98+
# Preview production build
99+
pnpm preview
100+
101+
# Run linting
102+
pnpm lint
103+
104+
# Fix linting issues
105+
pnpm lint:fix
106+
```
107+
108+
## 🏗️ Project Structure
109+
110+
```
111+
nimiq-tutorial/
112+
├── src/
113+
│ ├── components/ # Custom UI components
114+
│ ├── content/
115+
│ │ └── tutorial/ # Tutorial content
116+
│ │ ├── 0-introduction/
117+
│ │ ├── 1-connecting-to-network/
118+
│ │ ├── 2-working-with-transactions/
119+
│ │ ├── 3-staking-and-validators/
120+
│ │ └── 4-miscellaneous/
121+
│ └── templates/ # Code templates
122+
├── public/ # Static assets
123+
├── scripts/ # Build scripts
124+
└── dist/ # Production build
125+
```
126+
127+
## 🛠️ Technology Stack
128+
129+
- **[TutorialKit](https://tutorialkit.dev/)**: Interactive tutorial framework
130+
- **[Astro](https://astro.build/)**: Static site generator
131+
- **[Vue 3](https://vuejs.org/)**: Component framework
132+
- **[TypeScript](https://www.typescriptlang.org/)**: Type-safe JavaScript
133+
- **[UnoCSS](https://unocss.dev/)**: Atomic CSS engine
134+
- **[Nimiq Web Client](https://nimiq.dev/)**: Blockchain integration
135+
136+
## 📝 Contributing
137+
138+
We welcome contributions! Here's how you can help:
139+
140+
### 🐛 Reporting Issues
141+
142+
1. Use the "Feedback & Bugs" button in the tutorial
143+
2. Create detailed GitHub issues with:
144+
- Steps to reproduce
145+
- Expected vs actual behavior
146+
- Browser and environment details
147+
148+
### 🔧 Making Changes
149+
150+
1. Fork the repository
151+
2. Create a feature branch: `git checkout -b feature/your-feature`
152+
3. Make your changes following our coding standards
153+
4. Test thoroughly across different browsers
154+
5. Submit a pull request with a clear description
155+
156+
### 📚 Content Guidelines
157+
158+
When adding or modifying tutorial content:
159+
160+
- **Keep it Simple**: Use clear, jargon-free language
161+
- **Be Progressive**: Each step builds on the previous
162+
- **Include Examples**: Provide working code snippets
163+
- **Test Everything**: Ensure all examples work correctly
164+
- **Add Comments**: Explain complex code blocks
165+
166+
## 🎯 Learning Objectives
167+
168+
This tutorial is designed to help developers:
169+
170+
- **Understand blockchain fundamentals** without getting lost in complexity
171+
- **Build real applications** using Nimiq's browser-native approach
172+
- **Master Web Client APIs** through hands-on practice
173+
- **Develop best practices** for blockchain development
174+
- **Create production-ready** decentralized applications
175+
176+
## 🔗 Additional Resources
177+
178+
- **📖 [Official Nimiq Documentation](https://nimiq.dev/)**
179+
- **🌐 [Nimiq Website](https://nimiq.com/)**
180+
- **💬 [Telgream](https://t.me/Nimiq/)**
181+
182+
## 📄 License
183+
184+
This project is open source and available under the [MIT License](LICENSE).
185+
186+
---
187+
188+
<p align="center">
189+
<strong>Ready to build your first blockchain app?</strong><br>
190+
<a href="https://nimiq-tutorial.maximogarciamtnez.workers.dev/">Start the Tutorial →</a>
191+
</p>
192+
193+
<p align="center">
194+
Made with ❤️ by the Nimiq
8195
</p>
9-
<br/>

0 commit comments

Comments
 (0)