PROJECT_SETUP.md

Project setup

Komodo Wallet is a cross-platform application, meaning it can be built for multiple target platforms using the same code base. It is important to note that some target platforms may only be accessible from specific host platforms. Below is a list of all supported host platforms and their corresponding target platforms:

Host Platform	Target Platform
macOS	Web, macOS, iOS, iPadOS, Android
Windows	Web, Windows, Android
Linux	Web, Linux, Android

Host Platform Setup

1. Install Flutter, pin Flutter version

2. Install IDEs

   • VS Code
     • install and enable Dart and Flutter extensions
     • enable Dart: Use recommended settings via the Command Pallette
   • Android Studio - Flamingo | 2024.1.2
     • install and enable Dart and Flutter plugins
     • SDK Manager -> SDK Tools:
       • Android SDK Build-Tools 35
       • NDK (Side by side) 27.1
       • Android command line tools (latest)
       • CMake 3.30.3 (latest)
   • xCode - 15.4 (macOS only)
   • Visual Studio - Community 17.11.3 (Windows only)
     • Desktop development with C++ workload required

3. Run flutter doctor and make sure all checks (except version) pass

4. Clone project repository

5. Install nodejs and npm. Make sure npm is in your system PATH and you can run npm run build from the project root folder. Node LTS (v18, v20) is required.

In case of an error, try to run npm i.

6. Build and run the App for each target platform:
   • Web
   • Android mobile
   • iOS mobile (macOS host only)
   • macOS desktop (macOS host only)
   • Windows desktop (Windows host only)
   • Linux desktop (Linux host only)
7. Build release version

Dev Container setup (Web and Android builds only)

1. Install Docker for your operating system.
   • Linux: Install Docker for your distribution and add your user to the group by using terminal to run: sudo usermod -aG docker $USER.
   • Windows/macOS: Install Docker Desktop for Windows/macOS, and if you are using WSL in Windows, please ensure that the WSL 2 back-end is installed and configured.
2. Install VS Code
   • install and enable Dart and Flutter extensions
   • enable Dart: Use recommended settings via the Command Pallette
3. Install the VSCode Dev Container extension
4. Open the command palette (Ctrl+Shift+P) and run Remote-Containers: Reopen in Container