LeonardandEvan Simkowitz
94f76946fc
* Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
38 lines
945 B
Markdown
38 lines
945 B
Markdown
# Create a Project
|
|
|
|
Once you have the Dioxus CLI installed, you can use it to create your own project!
|
|
|
|
## Initializing a default project
|
|
|
|
First, run the `dx create` command to create a new project:
|
|
```
|
|
dx create hello-dioxus
|
|
```
|
|
|
|
> It will clone this [template](https://github.com/DioxusLabs/dioxus-template).
|
|
> This default template is used for `web` platform application.
|
|
>
|
|
> You can choose to create your project from a different template by passing the `template` argument:
|
|
> ```
|
|
> dx init hello-dioxus --template=gh:dioxuslabs/dioxus-template
|
|
> ```
|
|
|
|
Next, navigate into your new project:
|
|
|
|
```
|
|
cd hello-dioxus
|
|
```
|
|
|
|
> Make sure the WASM target is installed before running the projects.
|
|
> You can install the WASM target for rust using rustup:
|
|
> ```
|
|
> rustup target add wasm32-unknown-unknown
|
|
> ```
|
|
|
|
Finally, serve your project:
|
|
```
|
|
dx serve
|
|
```
|
|
|
|
By default, the CLI serves your website at [`http://127.0.0.1:8080/`](http://127.0.0.1:8080/).
|