|
10 | 10 | [](./CHANGELOG.md)
|
11 | 11 |
|
12 | 12 | # Usage
|
| 13 | + |
13 | 14 | To get started using `create-tauri-app` run one of the below commands in the folder you'd like to setup your project.
|
14 | 15 |
|
15 | 16 | ### Bash:
|
@@ -64,71 +65,73 @@ bunx create-tauri-app
|
64 | 65 | <br>
|
65 | 66 |
|
66 | 67 | ## Scaffold a new project (interactive)
|
67 |
| -Follow along with the prompts to choose your project name, frontend language, package manager, and frontend framework, and frontend framework options if applicable. |
68 | 68 |
|
| 69 | +Follow along with the prompts to choose your project name, frontend language, package manager, and frontend framework, and frontend framework options if applicable. |
69 | 70 |
|
70 | 71 | 1. Choose a name and a bundle identifier (unique-id for your app):
|
71 |
| - ``` |
72 |
| - ? Project name (tauri-app) › |
73 |
| - ? Identifier (com.tauri-app.app) › |
74 |
| - ``` |
| 72 | + ``` |
| 73 | + ? Project name (tauri-app) › |
| 74 | + ? Identifier (com.tauri-app.app) › |
| 75 | + ``` |
75 | 76 | 2. Select a flavor for your frontend. First the language:
|
76 |
| - ``` |
77 |
| - ? Choose which language to use for your frontend › |
78 |
| - Rust (cargo) |
79 |
| - TypeScript / JavaScript (pnpm, yarn, npm, bun) |
80 |
| - .NET (dotnet) |
81 |
| - ``` |
| 77 | + ``` |
| 78 | + ? Choose which language to use for your frontend › |
| 79 | + Rust (cargo) |
| 80 | + TypeScript / JavaScript (pnpm, yarn, npm, bun) |
| 81 | + .NET (dotnet) |
| 82 | + ``` |
82 | 83 | 3. Select a package manager (if there are multiple available):
|
83 | 84 |
|
| 85 | + Options for **TypeScript / JavaScript**: |
84 | 86 |
|
85 |
| - Options for **TypeScript / JavaScript**: |
86 |
| -
|
87 |
| - ``` |
88 |
| - ? Choose your package manager › |
89 |
| - pnpm |
90 |
| - yarn |
91 |
| - npm |
92 |
| - bun |
93 |
| - ``` |
| 87 | + ``` |
| 88 | + ? Choose your package manager › |
| 89 | + pnpm |
| 90 | + yarn |
| 91 | + npm |
| 92 | + bun |
| 93 | + ``` |
94 | 94 |
|
95 | 95 | 4. Select a UI Template and flavor (if there are multiple available):
|
96 | 96 |
|
97 |
| - Options for **Rust**: |
98 |
| - ``` |
99 |
| - ? Choose your UI template › |
100 |
| - Vanilla |
101 |
| - Yew |
102 |
| - Leptos |
103 |
| - Sycamore |
104 |
| - ``` |
105 |
| -
|
106 |
| - Options for **TypeScript / JavaScript**: |
107 |
| -
|
108 |
| - ``` |
109 |
| - ? Choose your UI template › |
110 |
| - Vanilla |
111 |
| - Vue |
112 |
| - Svelte |
113 |
| - React |
114 |
| - Solid |
115 |
| - Angular |
116 |
| - Preact |
117 |
| -
|
118 |
| - ? Choose your UI flavor › |
119 |
| - TypeScript |
120 |
| - JavaScript |
121 |
| - ``` |
122 |
| -
|
123 |
| - Options for **.NET**: |
124 |
| - ``` |
125 |
| - ? Choose your UI template › |
126 |
| - Blazor (https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor/) |
127 |
| - ``` |
| 97 | + Options for **Rust**: |
| 98 | + |
| 99 | + ``` |
| 100 | + ? Choose your UI template › |
| 101 | + Vanilla |
| 102 | + Yew |
| 103 | + Leptos |
| 104 | + Sycamore |
| 105 | + ``` |
| 106 | + |
| 107 | + Options for **TypeScript / JavaScript**: |
| 108 | + |
| 109 | + ``` |
| 110 | + ? Choose your UI template › |
| 111 | + Vanilla |
| 112 | + Vue |
| 113 | + Svelte |
| 114 | + React |
| 115 | + Solid |
| 116 | + Angular |
| 117 | + Preact |
| 118 | +
|
| 119 | + ? Choose your UI flavor › |
| 120 | + TypeScript |
| 121 | + JavaScript |
| 122 | + ``` |
| 123 | + |
| 124 | + Options for **.NET**: |
| 125 | + |
| 126 | + ``` |
| 127 | + ? Choose your UI template › |
| 128 | + Blazor (https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor/) |
| 129 | + ``` |
128 | 130 |
|
129 | 131 | 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.
|
130 | 132 |
|
131 | 133 | ## Scaffold a new project (non-interactive)
|
| 134 | + |
132 | 135 | You can also directly specify the project name, package manager and the template you want to use via additional command line options. For example, to scaffold a Svelte project in a `my-tauri-app` directory, run:
|
133 | 136 |
|
134 | 137 | ```bash
|
|
0 commit comments