MindWorkAI/AI-Studio
MindWorkAI/AI-Studio
1
0
Fork 0
mirror of https://github.com/MindWorkAI/AI-Studio.git synced 2025-04-28 10:39:47 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Updated the build instructions

Browse Source
This commit is contained in:
Thorsten Sommer 2025-04-14 19:03:50 +02:00
parent 6a7156df37
commit 7f43b9ab9d
Signed by: tsommer
GPG Key ID: 371BBA77A02C0108
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
documentation/Build.md
View File

@ -6,30 +6,28 @@ You just want to use the app? Then simply [download the appropriate setup for yo
2. [Install the Rust compiler](https://www.rust-lang.org/tools/install) in the latest version. 2. [Install the Rust compiler](https://www.rust-lang.org/tools/install) in the latest version.
3. Met the prerequisites for building [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites/). Node.js is **not** required, though. 3. Met the prerequisites for building [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites/). Node.js is **not** required, though.
4. Install the Tauri CLI by running `cargo install --version 1.6.2 tauri-cli`. 4. Install the Tauri CLI by running `cargo install --version 1.6.2 tauri-cli`.
5. [Install NuShell](https://www.nushell.sh/). NuShell works on all operating systems and is required because the build script is written in NuShell. 5. Clone the repository.
6. Clone the repository.
## One-time mandatory steps ## One-time mandatory steps
Regardless of whether you want to build the app locally for yourself (not trusting the pre-built binaries) or test your changes before creating a PR, you have to run the following commands at least once: Regardless of whether you want to build the app locally for yourself (not trusting the pre-built binaries) or test your changes before creating a PR, you have to run the following commands at least once:
1. Open a terminal using NuShell. 1. Open a terminal.
2. Navigate to the `/app/MindWork AI Studio` directory within the repository. 2. Navigate to the `/app/Build` directory within the repository.
3. Run `dotnet restore` to bring up the .NET dependencies. 3. Run `dotnet run build` to build the entire app.
4. Run `nu build.nu publish` to build the entire app.
This is necessary because the build script and the Tauri framework assume that the .NET app is available as a so-called "sidecar." Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development as well. This is necessary because the build script and the Tauri framework assume that the .NET app is available as a so-called "sidecar." Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development as well.
## Build AI Studio from source ## Build AI Studio from source
In order to build MindWork AI Studio from source instead of using the pre-built binaries, follow these steps: In order to build MindWork AI Studio from source instead of using the pre-built binaries, follow these steps:
1. Ensure you have met all the prerequisites. 1. Ensure you have met all the prerequisites.
2. Open a terminal with NuShell. 2. Open a terminal.
3. Navigate to the `/app/MindWork AI Studio` directory within the repository. 3. Navigate to the `/app/Build` directory within the repository.
4. To build the current version, run `nu build.nu publish` to build the entire app. 4. To build the current version, run `dotnet run build` to build the entire app.
- This will build the app for the current operating system, for both x64 (Intel, AMD) and ARM64 (e.g., Apple Silicon, Raspberry Pi). - This will build the app for the current operating system, for both x64 (Intel, AMD) and ARM64 (e.g., Apple Silicon, Raspberry Pi).
- The final setup program will be located in `runtime/target/release/bundle` afterward. - The final setup program will be located in `runtime/target/release` afterward.
5. In order to create a new release: 5. In order to create a new release:
1. Before finishing the PR, make sure to create a changelog file in the `/app/MindWork AI Studio/wwwroot/changelog` directory. The file should be named `vX.Y.Z.md` and contain the changes made in the release (your changes and any other changes that are part of the release). 1. Before finishing the PR, make sure to create a changelog file in the `/app/MindWork AI Studio/wwwroot/changelog` directory. The file should be named `vX.Y.Z.md` and contain the changes made in the release (your changes and any other changes that are part of the release).
2. To prepare a new release, run `nu build.nu prepare <ACTION>`, where `<ACTION>` is either `patch`, `minor`, or `major`. 2. To prepare a new release, run `dotnet run release --action <ACTION>`, where `<ACTION>` is either `patch`, `minor`, or `major`.
3. The actual release will be built by our GitHub Workflow. For this to work, you need to create a PR with your changes. 3. The actual release will be built by our GitHub Workflow. For this to work, you need to create a PR with your changes.
4. Your proposed changes will be reviewed and merged. 4. Your proposed changes will be reviewed and merged.
5. Once the PR is merged, a member of the maintainers team will create & push an appropriate git tag in the format `vX.Y.Z`. 5. Once the PR is merged, a member of the maintainers team will create & push an appropriate git tag in the format `vX.Y.Z`.
@ -39,8 +37,8 @@ In order to build MindWork AI Studio from source instead of using the pre-built
## Run the app locally with all your changes ## Run the app locally with all your changes
Do you want to test your changes before creating a PR? Follow these steps: Do you want to test your changes before creating a PR? Follow these steps:
1. Ensure you have met all the prerequisites. 1. Ensure you have met all the prerequisites.
2. At least once, you have to run the `nu build.nu publish` command (see above, "Build instructions"). This is necessary because the Tauri framework checks whether the .NET app as so-called "sidecar" is available. Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development. 2. At least once, you have to run the `dotnet run build` command (see above, "Build instructions"). This is necessary because the Tauri framework checks whether the .NET app as so-called "sidecar" is available. Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development.
3. Open a terminal (in this case, it doesn't have to be NuShell). 3. Open a terminal.
4. Navigate to the `runtime` directory within the repository, e.g. `cd repos/mindwork-ai-studio/runtime`. 4. Navigate to the `runtime` directory within the repository, e.g. `cd repos/mindwork-ai-studio/runtime`.
5. Run `cargo tauri dev --no-watch`. 5. Run `cargo tauri dev --no-watch`.