[docs] I just went through the quickstart and noticed a few issues
See original GitHub issueI ended up having to start over because I followed the guide which led me astray.
I was following https://tauri.app/v1/guides/getting-started/setup/vite
I started with yarn create tauri-app
Create the Rust Project
-> this was already done as part ofyarn create tauri-app
, so when I attempted to do this I got an error saying that thesrc-tauri
directory was not empty and I did a force install as suggested. Instead all I really needed to do was edittauri.conf.json
and change the port (but I was not sure if other stuff would have been different, which is why I opted for force the first time)- In addition, the instructions to update
src-tauri/tauri.conf.json
do not honor yarn/npm/pnmp configuration
- In addition, the instructions to update
- This command offered to add
@tauri-apps/api
for me (and I accepted), so I did not need to explicitly do this step called out in the docs
Also, on the Development Cycle page - this is called out:
In your project repository, you SHOULD commit the “src-tauri/Cargo.lock” along with the “src-tauri/Cargo.toml” to git because Cargo uses the lockfile to provide deterministic builds. As a result, it is recommended that all applications check in their Cargo.lock. You SHOULD NOT commit the “src-tauri/target” folder or any of its contents.
Ideally the cli would manage this by default for projects structured in the standard way - src-tauri/target
should be added to .gitignore
by default since the cli generated the file to start with.
Issue Analytics
- State:
- Created a year ago
- Comments:6 (4 by maintainers)
Reading through the
create-tauri-app
callout at the top I guess we don’t do a good job explaining that it’s an ALTERNATIVE to manually setting up tauri with the rest of the guide. So we can do some work to update the phrasing to highlight that.Thanks for the feedback @paustint and @jayber, we’ve updated the phrasing in the annotation at the top of the pages:
The content in the guides roughly line up with the output of
create-tauri-app
for a chosen framework so we added a line to recommend the reader to read through the rest of the guide to understand whatcreate-tauri-app
has done for them and to also understand the setup of the scaffolded project.