6. Account and settings
6.4 The framework instructions
Editing the recipes of “New project”: bases, additions, commands, .env variables, actions. And trying a combination before using it.
In the app: «Settings»
In short
- The bases and additions of “New project” are recipes: lists of commands you can read and change.
- You find them in Settings, in the “Frameworks” panel.
- You can change an official recipe (and restore it) or create your own.
- “Try a combination” shows what a base with some additions would do, before you use it.
What a recipe is made of
- ToolsThe kit components it needs (Node.js, PHP…).
- CreateThe commands that create the project, run in the projects folder.
- ThenThe commands to run in the project's folder.
- ExtrasDatabase, .env variables, project actions.
Each line is a command run with PowerShell and the kit's tools. {name} becomes the project's name (in quotes), {package} com.example. followed by the name in lowercase.
The “Frameworks” panel
The tree has the “Bases”, divided by group, and under each base the additions that go with it; then the “Additions” by type; at the bottom “Try a combination”. At the top, the “Add a base” and “Add an addition” icons.
| Field | What to write |
|---|---|
| Name, Description, Official page | How it appears in the wizard and the link to the documentation. |
| Kit tools | The components to install first (“Add a kit tool”). |
| Create the project (in the projects folder) | For example: npm create vite@latest {name} -- --template vanilla-ts |
| Then, in the project's folder | For example: npm install |
| Kit database for the project | None, MySQL or MongoDB. The password the wizard generates for the database wins over an empty one from the base (for example DB_PASSWORD= in .env.example). |
| .env file variables (KEY=value) | For example: APP_NAME={name} |
| Project actions (Name: command) | For example: Start: npm run dev |
An addition also has the “Group” (two additions of the same group do not go together), “Use it also with” for the compatible bases and, for each base, the commands to add or “Create the project instead of the base”.
- Choose a base or an addition in the tree and edit the fields.
- The instructions save themselves a little under a second after the last edit: the tab bar shows “Saving…”, then “Saved.”. A changed official recipe shows “Modified”.
- To go back to the original version use “Restore the official instructions”; a recipe of your own is removed with “Remove”.
Try a combination
Choose a base and some additions: the tab shows the complete plan the wizard would run (tools, commands, database, .env, actions), with the instructions as they are now, even if the last edit is not saved yet. It runs nothing.
Under the hood
- The official recipes are in the kit's catalog (tauri/catalog/frameworks.json): 63 bases and 18 additions.
- Your changes are in data\app\frameworks.json, which contains only the differences from the official recipes.
- The bases saved from a project with “Save as a base” are in the “My bases” group (category “mine”): instead of the “Create the project” commands they have the template field, the folder of data\frameworks\mine to copy. A base must have the creation commands or a valid template. Removing one with “Remove”, its folder goes too at the save.
- If that file cannot be read, the kit uses the official recipes and does not touch it: “The instructions in … cannot be read: using the official ones and leaving the file as it is.”