Guides

TL;DR: Guides show you how to build, deploy, and migrate SharePoint Framework solutions with RSPFx. Follow them in order to go from install to production.

RSPFx replaces the SPFx toolchain with Vite, Rsbuild, or Rspack. You keep the same manifests and .sppkg output.

Use this page to find the right guide for your task.

Start here

• Why RSPFx - understand what you gain with RSPFx.
• Getting started - create a project and run it in four steps.
• Demos - explore runnable examples by framework and bundler.

Build and deploy

• Dev vite quick start - one-command rspfx dev:vite to try dev mode in any project.
• Dev server - run local preview and workbench on port 4321.
• Lean dev plugin - vite-first dev-only plugin without heavy deps.
• Deployment guide - build, package, and upload to the app catalog.
• Styling - handle CSS, SCSS, Tailwind, and inlining.
• Fast refresh - preserve state while you edit.

Choose your stack

• Choosing a framework - pick React, Vue, Svelte, or others.
• React 19 - use React 19 and the compiler with RSPFx.
• Custom framework guide - add your own framework preset.

Migration

• Migration overview - decide if and how you should migrate.
• Migration from SPFx - move an existing project step by step.
• Migrating from gulp and Heft - detailed checklist for gulp and Heft removal.
• Migration case study - see how a large real project migrated.
• Hybrid dev - try RSPFx dev without changing your project.
• Upgrading SPFx version - switch SPFx targets with one field.
• Why not to migrate - check blockers before you move.

Project setup

• Multi web part - ship several web parts in one package.
• Favicon and assets - add icons and static files.
• Teams and Outlook install - sync your solution to Teams and Outlook.

Reference links

For exact flags, types, and file paths, see reference:

• Commands
• Architecture
• Compatibility
• Reference index