Files
dioxus/docs/guide/src/en/getting_started/index.md
T
ealmloff cd4474cc4f Update docs to reflect changes in master (#670)
* work on updating docs to master version

* more updates

* more polishing

* finish interactivity chapter

* finish updating core guide

* fix grammer mistakes and typos

* more grammer fixes

* add liveview guide

* remove doc build

* WIP custom renderer docs

* add axum as dev-dependancy to guide

* fix examples

* fix overview example

* use md book fork to fix compilation
2023-01-06 15:00:12 -08:00

1.4 KiB

Getting Started

This section will help you set up your Dioxus project!

Prerequisites

An Editor

Dioxus integrates very well with the Rust-Analyzer LSP plugin which will provide appropriate syntax highlighting, code navigation, folding, and more.

Rust

Head over to https://rust-lang.org and install the Rust compiler.

We strongly recommend going through the official Rust book completely. However, we hope that a Dioxus app can serve as a great first Rust project. With Dioxus, you'll learn about:

  • Error handling
  • Structs, Functions, Enums
  • Closures
  • Macros

We've put a lot of care into making Dioxus syntax familiar and easy to understand, so you won't need deep knowledge of async, lifetimes, or smart pointers until you start building complex Dioxus apps.

Setup Guides

Dioxus supports multiple platforms. Choose the platform you want to target below to get platform-specific setup instructions:

  • Web: runs in the browser through WebAssembly
  • Server Side Rendering: renders to HTML text on the server
  • Liveview: runs on the server, renders in the browser using WebSockets
  • Desktop: runs in a web view on desktop
  • Mobile: runs in a web view on mobile
  • Terminal UI: renders text-based graphics in the terminal