cake_wallet/howto-build-macos.md

103 lines
3.1 KiB
Markdown

# Building CakeWallet for macOS
## Requirements and Setup
The following are the system requirements to build CakeWallet for your macOS device.
```
macOS >= 14.0
Xcode 15.3
Flutter 3.10.x
```
## Building CakeWallet on macOS
These steps will help you configure and execute a build of CakeWallet from its source code.
### 1. Installing Package Dependencies
CakeWallet cannot be built without the following packages installed on your build system.
For installing dependency tools you can use brew [Install brew](https://brew.sh).
You may easily install them on your build system with the following command:
`$ brew install cmake xz unbound boost@1.76 zmq cocoapods`
`$ brew link boost@1.76`
### 2. Installing Xcode
You may download and install the latest version of [Xcode](https://developer.apple.com/xcode/) from macOS App Store.
### 3. Installing Flutter
Need to install flutter with version `3.10.x`. For this please check section [Install Flutter](https://docs.flutter.dev/get-started/install/macos/desktop?tab=download).
### 4. Verify Installations
Verify that Flutter and Xcode have been correctly installed on your system with the following command:
`$ flutter doctor`
The output of this command will appear like this, indicating successful installations. If there are problems with your installation, they **must** be corrected before proceeding.
```
Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, 3.10.x, on macOS 14.x.x)
[✓] Xcode - develop for iOS and macOS (Xcode 15.3)
```
### 5. Acquiring the CakeWallet source code
Download the source code.
`$ git clone https://github.com/cake-tech/cake_wallet.git --branch main`
Proceed into the source code before proceeding with the next steps:
`$ cd cake_wallet/scripts/macos/`
### 6. Execute Build & Setup Commands for CakeWallet
We need to generate project settings like app name, app icon, package name, etc. For this need to setup environment variables and configure project files.
Please pick what app you want to build: cakewallet or monero.com.
`$ source ./app_env.sh <cakewallet OR monero.com>`
(it should be like `$ source ./app_env.sh cakewallet` or `$ source ./app_env.sh monero.com`)
Then run configuration script for setup app name, app icon and etc:
`$ ./app_config.sh`
Build the Monero libraries and their dependencies:
`$ ./build_monero_all.sh`
It is now time to change back to the base directory of the CakeWallet source code:
`$ cd ../../`
Install Flutter package dependencies with this command:
`$ flutter pub get`
Your CakeWallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:
`$ flutter packages pub run tool/generate_new_secrets.dart`
Then we need to generate localization files and mobx models.
`$ ./configure_cake_wallet.sh macos`
### 7. Build!
`$ flutter build macos --release`
Then you can open `macos/Runner.xcworkspace` with Xcode and you can to archive the application.
Or if you want to run to connected device:
`$ flutter run --release`
Copyright (c) 2024 Cake Technologies LLC.