鱼皮AI导航
鱼皮AI导航
  • 主页
  • 社区
  • AI工具
  • AI知识库
  • AI提示词
  • MCP
  • Skills
  • AI学习资源
  • AI资讯
  • GitHub开源
登录/注册

webf-quickstart

通过标准 Web 开发工具快速构建可在原生环境中运行的应用,支持使用 Vite 创建 React Vue Svelte 项目并实时预览,配合专用测试客户端实现移动端与桌面端的即时加载和调试,适用于开发测试阶段的高效迭代。

区块链软件开发
访问 GitHub
文档Skills.MD
name
webf-quickstart
description
Get started with WebF development - setup WebF Go, create a React/Vue/Svelte project with Vite, and load your first app. Use when starting a new WebF project, onboarding new developers, or setting up development environment.

WebF Quickstart

Note: Building WebF apps is nearly identical to building regular web apps with Vite + React/Vue/Svelte. The only difference is you replace your browser with WebF Go for testing during development. Everything else - project structure, build tools, testing frameworks, and deployment - works the same way.

⚠️ IMPORTANT: WebF Go is for development and testing ONLY. For production, you must build a Flutter app with WebF integration. Do NOT distribute WebF Go to end users.

Get up and running with WebF in minutes. This skill guides you through setting up your development environment, creating your first project, and loading it in WebF Go.

What You Need

Only Node.js is required - that's it!

  • Node.js (LTS version recommended) from nodejs.org
  • You do NOT need: Flutter SDK, Xcode, or Android Studio

WebF lets web developers build native apps using familiar web tools.

Step-by-Step Setup

1. Download WebF Go (For Testing Only)

WebF Go is a pre-built native app containing the WebF rendering engine. It's designed for development and testing purposes only - not for production deployment.

For Desktop Development:

  • Download WebF Go for your OS (macOS, Windows, Linux)
  • Get it from: https://openwebf.com/en/go

For Mobile Testing:

  • iOS: Download from App Store
  • Android: Download from Google Play

Remember: WebF Go is a testing tool. For production apps, you'll need to build a Flutter app with WebF integration.

Launch WebF Go - you'll see an input field ready to load your app.

2. Create Your Project with Vite

Open your terminal and create a new project:

▼
bash
复制代码
npm create vite@latest my-webf-app

Vite will prompt you to:

  1. Choose a framework: React, Vue, Svelte, etc.
  2. Choose a variant (JavaScript or TypeScript)

3. Install Dependencies and Start Dev Server

▼
bash
复制代码
# Move into your project cd my-webf-app # Install dependencies npm install # Start the dev server npm run dev

Your terminal will show URLs like:

▼
text
复制代码
VITE v5.0.0 ready in 123 ms ➜ Local: http://localhost:5173/ ➜ Network: http://192.168.1.100:5173/

4. Load in WebF Go

For Desktop:

  1. Copy the http://localhost:5173/ URL
  2. Paste into WebF Go's input field
  3. Press Enter or click "Go"

For Mobile Device: ⚠️ IMPORTANT: Mobile devices cannot access localhost

You MUST use the Network URL instead:

  1. Make sure your computer and mobile device are on the same WiFi network
  2. Use --host flag to expose the dev server:
    ▼
    bash
    复制代码
    npm run dev -- --host
  3. Copy the Network URL (e.g., http://192.168.1.100:5173/)
  4. Type it into WebF Go on your mobile device
  5. Press "Go"

Your app will now render in WebF! 🎉

5. Verify Hot Reload

Make a quick change to your code and save. The app should automatically update - this is Vite's Hot Module Replacement (HMR) working with WebF.

6. (Optional) Setup Chrome DevTools

To debug your app:

  1. Click the floating debug button in WebF Go
  2. Click "Copy" to get the DevTools URL (devtools://...)
  3. Paste into desktop Google Chrome browser
  4. You can now use Console, Elements, Network tabs

Note: JavaScript breakpoints don't work yet - use console.log() instead.

Common Issues and Solutions

Issue: "Cannot connect" on mobile device

Causes & Solutions:

  • ✗ Using localhost → ✓ Use Network URL (http://192.168.x.x:5173)
  • ✗ Different WiFi networks → ✓ Put both devices on same network
  • ✗ Missing --host flag → ✓ Use npm run dev -- --host
  • ✗ Firewall blocking port → ✓ Allow port 5173 through firewall

Issue: "Connection refused"

  • Dev server not running → Run npm run dev
  • Wrong port number → Check terminal output for correct port
  • Firewall blocking → Temporarily disable to test

Issue: App loads but doesn't update

  • HMR not working → Refresh the page manually
  • Dev server error → Check terminal for errors
  • Network connection lost → Reconnect WiFi

Production Deployment

⚠️ WebF Go is NOT for production use. It's a testing tool for developers.

For Production Apps

When you're ready to deploy to end users, you need to:

1. Build Your Web Bundle

▼
bash
复制代码
npm run build

2. Host Your Bundle

  • Deploy to any web hosting (Vercel, Netlify, CDN, etc.)
  • Your bundle will be accessible via URL (e.g., https://your-app.com)

3. Create a Flutter App with WebF Integration

You or your Flutter team needs to:

  • Set up a Flutter project
  • Add the WebF Flutter package to pubspec.yaml
  • Configure the app (name, icon, splash screen, permissions)
  • Load your web bundle URL in the WebF widget

Example Flutter Integration:

▼
dart
复制代码
import 'package:webf/webf.dart'; class MyApp extends StatelessWidget { @override Widget build(BuildContext context) { return WebF( bundle: WebFBundle.fromUrl('https://your-app.com'), ); } }

4. Build and Deploy Flutter App

  • Build for iOS and Android
  • Submit to App Store and Google Play

Resources:

  • WebF Integration Guide
  • Flutter App Setup

Development vs Production

AspectDevelopmentProduction
ToolWebF GoCustom Flutter app
PurposeTesting & iterationEnd-user distribution
SetupDownload and runBuild Flutter app
DistributionDon't distributeApp Store/Google Play
RequirementsNode.js onlyFlutter SDK required

Next Steps

Now that you have a working dev environment:

  1. Learn the #1 difference: WebF uses async rendering - see the webf-async-rendering skill
  2. Check API compatibility: Not all web APIs work in WebF - see webf-api-compatibility skill
  3. Add navigation: Multi-screen apps use WebF routing - see webf-routing-setup skill

Quick Reference

▼
bash
复制代码
# Create new project npm create vite@latest my-app # Start dev server (desktop) npm run dev # Start dev server (mobile - with network access) npm run dev -- --host # Install dependencies npm install # Build for production npm run build

Resources

  • Getting Started Guide: https://openwebf.com/en/docs/developer-guide/getting-started
  • WebF Go Guide: https://openwebf.com/en/docs/learn-webf/webf-go
  • Development Workflow: https://openwebf.com/en/docs/developer-guide/development-workflow
  • Download WebF Go: https://openwebf.com/en/go
  • Full Documentation: https://openwebf.com/en/docs
区块链
软件开发

快捷安装

复制到终端去安装 Skill

npxskillsaddopenwebf/webf--skill"webf-quickstart"
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
🔥热门工具
朱雀AI检测朱雀AI检测
朱雀AI检测助手朱雀AI检测助手
LovartLovart
老鱼简历老鱼简历
WritePass官网WritePass官网
面多多面多多
CursorCursor
星月写作星月写作
朱雀AI检测助手朱雀AI检测助手
零感AI零感AI
Skills 推荐
debug
debug 是一个系统化定位软件缺陷根因的技能,适用于用户报告 'fix'、'broken'、'error' 等问题或测试意外失败时。它通过可验证的假设、最小复现、因果链分析和回归测试,确保在修复前准确定位根本原因。
retrieving-developer-knowledge
retrieving-developer-knowledge 用于搜索、获取和整合 Google 官方开发者文档,覆盖 Google Cloud、AI/Gemini、Android、Chrome、Web、Flutter、Go、Firebase 等平台,适用于查询 gcloud CLI 命令、API 语法、IAM 权限或架构对比等场景。
diff-intake
diff-intake 读取 PR 或分支差异,生成结构化 YAML 变更摘要,用于下游 analytics instrumentation 技能。适用于用户提交 PR 链接、分支对比或原始 diff 后需理解变更内容、评估分析覆盖或启动埋点流程的场景。
implement
实现 Linus Dashboard 的功能开发与集成,基于 TypeScript 和 Python 构建前后端组件,遵循严格的代码规范与架构模式,完成视图、卡片、服务及传感器等模块的创建与验证,确保高质量交付并兼容 Home Assistant 生态。
pypi-server
支持从源码构建 Python 软件包,并搭建本地 PyPI 服务,实现私有包的托管与分发,使团队可通过 pip 直接安装内部开发的模块。