tauri-docs
tauri-docs copied to clipboard
[docs] Add an explanation to Quick Start about the options of create-tauri-app
Observed Behavior
The quick-start / README just says to use create-tauri-app
- https://tauri.app/v1/guides/getting-started/setup/
- https://github.com/tauri-apps/tauri-docs/blob/v1/docs/guides/getting-started/setup/README.mdx
but the options are not explained.
You can figure out what options there are, by running the utility multiple times. I think it helps to get an overview of how the tool works and which choices need to be made before using it. Also, this makes it easier for beginners to follow the guide in a step by step way.
There is a list when you follow the link create-tauri-app, but this is flat list which doesn't explain the tool either.
Expected behavior
- It would be great if the options were explained in the guide, so that you can follow them along.
- For the different favors, it would be great to show how to reproduce them with the setup tool (in addition to showing how to reproduce them by hand).
Proposal
Scaffold a new project with the create-tauri-app utility
First, you need to choose a name and a bundle identifier (unique-id for your app).
? Project name (tauri-app) ›
? Identifier (com.tauri-app.app) ›
Then you need to select a flavor for your frontend. This is done by selecting the language, a package manager (if there are multiple available) and a template:
? Choose which language to use for your frontend ›
Rust (cargo)
TypeScript / JavaScript (pnpm, yarn, npm, bun)
.NET (dotnet)
Options for Rust:
? Choose your UI template ›
Vanilla
Yew
Leptos
Sycamore
Options for TypeScript / JavaScript:
? Choose your package manager ›
pnpm
yarn
npm
bun
? Choose your UI template ›
Vanilla
Vue
Svelte
React
Solid
Angular
Preact
? Choose your UI flavor ›
TypeScript
JavaScript
Options for .NET:
? Choose your UI template ›
Blazor (https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor/)
Once completed, the utility reports that the template has been created and displays how to run it using the configured package manager. If it detects missing decencies on your system, it prints a list of packages and prompts how to install them.
I'm happy to create a PR to add the proposed descriptions to the documentation, if there is an agreement that those sections are helpful and will be maintained!
Probably this PR should go into the README of create-tauri-app and then be referenced from there.
@peppergrayxyz thanks for the proposal, feel free to open a PR if you'd like. I will move this issue to the docs repo.
@amrbashir thanks for merging https://github.com/tauri-apps/create-tauri-app/pull/809, don't know if you overlooked https://github.com/tauri-apps/tauri-docs/pull/2793 before closing this one!