webf-quickstart

Scaffold a Vite-based frontend and load it into WebF Go for testing.

2.5k|163|Updated Jul 19, 2022
One-click install
npx skills add https://github.com/openwebf/webf --skill webf-quickstart-openwebf
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webf-quickstart
Source: https://github.com/openwebf/webf/tree/main/skills/webf-quickstart
Command: npx skills add https://github.com/openwebf/webf --skill webf-quickstart-openwebf

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps developers quickly bootstrap a WebF project with WebF Go and a Vite-based frontend, reducing onboarding time and setup friction for new WebF projects.

Core Features & Use Cases

  • Step-by-step setup: guides you through installing Node.js, creating a Vite project, installing dependencies, and running the dev server.
  • Framework-agnostic bootstrapping: works with React, Vue, Svelte, or vanilla JS via Vite-based templates.
  • Live testing in WebF Go: demonstrates loading the app in WebF Go for desktop and mobile testing.
  • Use Case: when onboarding a new developer, this skill helps spin up a ready-to-run WebF project quickly.

Quick Start

Follow these commands to scaffold a new project, install dependencies, start the dev server, and load the app into WebF Go.

  1. Create a new project with Vite: npm create vite@latest my-webf-app

  2. Move into the project and install dependencies: cd my-webf-app npm install

  3. Start the development server: npm run dev

  4. Enable network access for mobile testing (optional): npm run dev -- --host

  5. Load the app in WebF Go by pasting the dev server URL (e.g., http://localhost:5173) into WebF Go.

Frequently Asked Questions about webf-quickstart

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I bootstrap a WebF project with Vite?

To bootstrap a WebF project with Vite, run `npm create vite@latest`, install dependencies, start the dev server, and load the local URL into WebF Go. This ensures a reproducible development environment for testing.

Can I use React, Vue, or Svelte to start a WebF project?

Yes, WebF supports framework-agnostic bootstrapping, allowing you to start a WebF project using React, Vue, Svelte, or vanilla JS via Vite-based templates. You can easily set up cross-framework configurations within a single workflow.

How do I test my Vite frontend in WebF Go on mobile?

To test your Vite frontend in WebF Go on mobile, start the dev server with network access using `npm run dev -- --host`. Then, load the provided local URL into WebF Go for desktop and mobile testing.

What do I need to install before setting up a WebF project?

Before setting up a WebF project, you need Node.js and npm installed to create the Vite project and install dependencies. These tools are required to scaffold the frontend and run the development server.

What is the best way to onboard new developers to a WebF project?

The best way to onboard new developers to a WebF project is by scaffolding a Vite-based frontend and loading it into WebF Go. This reduces setup friction and quickly spins up a ready-to-run project for rapid prototyping.