github_pulse/BUILD.md

Build Instructions

Note

Building has only been tested for linux. Please report bugs with building on any other platform.

Prerequisites

• Node.js (v18+)
• Git
• Flet v0.28.0
• Flutter SDK v3.29.0 (Flet will install this automatically, but you can also install it manually)
• Visual Studio 2016 (Windows Users)
• Android Studio (for Android builds)
• Xcode (for iOS builds)
• Any required package managers (e.g., npm, yarn)

Important

Flet v0.28.9 only supports Flutter SDK v3.29.0. Using other versions may lead to build failures. Flutter SDK v3.29.0 only supports Visual Studio 2016 on Windows. Ensure you have the correct version installed.

Clone the Repository

git clone https://github.com/TySP-Dev/github_pulse.git
cd github_pulse/src

Python Virtual Environment

# Create virtual environment
python -m venv venv

# Activate virtual environment
# On Windows:
venv\Scripts\activate

# On macOS/Linux:
source venv/bin/activate

Install Dependencies

# For dev dependencies
pip install -r requirements/requirements-dev.txt

# Linux Dependencies (Ubuntu/Debian)
sudo apt update
sudo apt upgrade
sudo apt install clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev

Setup Flutte

# Set ICU data file path (Windows example)
$env:FLUTTER_ICU_DATA_FILE="C:\path\to\flutter\bin\cache\artifacts\engine\windows-x64\icudtl.dat" 

Example path $env:FLUTTER_ICU_DATA_FILE="C:\Users<username>\flutter\bin\cache\artifacts\engine\windows-x64\icudtl.dat"

# Verify Flutter installation
flutter --version

# Run Flutter doctor
flutter doctor

# Flet doctor
python -m flet.cli doctor

# Accept Android licenses (if building for Android)
flutter doctor --android-licenses

# Precache Flutter artifacts (All platforms)
flutter precache --all

# precache Flutter artifacts (Windows example)
flutter precache --windows

# precache Flutter artifacts (Linux example)
flutter precache --linux

# precache Flutter artifacts (MacOS example)
flutter precache --macos

# precache Flutter artifacts (iOS example)
flutter precache --ios

# precache Flutter artifacts (Android example)
flutter precache --android

Note

Only precache the platforms you intend to build for.

Build the Application

Note

Ensure you are in the src directory of the project and the Python virtual environment is activated. venv\Scripts\activate (Windows) or source venv/bin/activate (macOS/Linux).

# Windows
flet build windows

# Linux
flet build linux

# Android
flet build apk

# macOS
flet build macos

# iOS
flet build ios

Additional Notes

• See README.md for more details.
• For troubleshooting, check the logs or open an issue.
• Customize build scripts in package.json as needed.