mirror of https://github.com/DioxusLabs/dioxus synced 2024-11-26 22:20:19 +00:00

History

Evan Almloff 519ec9d294 Move the document trait into a separate crate (#3035 ) * add a default head method through eval * remove the old document trait * implement document for each platform * pull out document into a dedicated crate to cut down on shared dependencies --------- Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>		2024-10-14 10:33:37 -07:00
..
assets	Fix: Make Toast Fixed & Increase Z-Index (#2850 )	2024-08-16 10:54:35 -07:00
src	Move the document trait into a separate crate (#3035 )	2024-10-14 10:33:37 -07:00
.gitignore	Prepare CLI for move into mainline	2023-06-28 17:21:23 -07:00
build.rs	Hotreloading of `for/if/body`, formatted strings, literals, component props, nested rsx, light CLI rewrite, cli TUI (#2258 )	2024-07-17 19:11:18 -07:00
Cargo.toml	Remove dependency on atty (#3047 )	2024-10-10 13:24:50 +00:00
Dioxus.toml	Add a deprecation warning for the resource option in dioxus.toml (#2642 )	2024-07-24 17:52:28 -07:00
README.md	Fix cli readme local installation instructions (#2671 )	2024-07-23 10:57:51 -07:00

README.md

📦✨ Dioxus CLI

Tooling to supercharge Dioxus projects

The dioxus-cli (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running. It handles building, bundling, development and publishing to simplify development.

Installation

Install the stable version (recommended)

cargo install dioxus-cli

Install the latest development build through git

To get the latest bug fixes and features, you can install the development version from git. However, this is not fully tested. That means you're probably going to have more bugs despite having the latest bug fixes.

cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli

This will download the CLI from the master branch, and install it in Cargo's global binary directory (~/.cargo/bin/ by default).

Install from local folder

Note: The CLI will fail to build projects in debug profile. This is currently under investigation.

cargo install --path .

Developing The CLI

It's faster to build the CLI using the cli-dev profile when testing changes.

cargo build --profile cli-dev

Get started

Use dx new to initialize a new Dioxus project. It will be cloned from the dioxus-template repository.

Alternatively, you can specify the template path:

dx new --template gh:dioxuslabs/dioxus-template

Run dx --help for a list of all the available commands. Furthermore, you can run dx <command> --help to get help with a specific command.

Dioxus config file

You can use the Dioxus.toml file for further configuration. Some fields are mandatory, but the CLI tool will tell you which ones are missing. You can create a Dioxus.toml with all fields already set using dx config init project-name, or you can use this bare-bones template (only mandatory fields) to get started:

[application]
name = "project-name"
# Currently supported platforms: web, desktop
default_platform = "web"

[web.app]
title = "Hello"

[web.watcher]

[web.resource.dev]

The full anatomy of Dioxus.toml is shown on the Dioxus website.