github_pulse/BUILD.md

Build Instructions

Prerequisites

• Node.js (v18+)
• Git
• Flet v0.28.0
• Flutter SDK v3.29.0 (Use FVM for managing Flutter versions)
• Visual Studio 2016 (Windows Users)
• Android Studio (for Android builds)
• Xcode (for iOS builds)
• Any required package managers (e.g., npm, yarn)

Clone the Repository

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

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

pip install -r requirements.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 Flutter

# Install FVM
dart pub global activate fvm

# Add to path
export PATH="$PATH":"$HOME/.pub-cache/bin"

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

# Install Flutter version 3.29.0
fvm install 3.29.0

fvm use 3.29.0 --force

# Get cached Flutter versions
fvm list

# Create a temporary alias for Flutter (Windows example)
function flutter { fvm flutter $args }

# Create a temporary alias for Flutter (Linux / MacOS example)
alias flutter="fvm flutter"

# Verify Flutter installation
flutter --version
# Should show Flutter 3.29.0

# 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

# Windows
python -m flet.cli build windows

# Linux
python -m flet.cli build linux

# Android
python -m flet.cli build apk

# macOS
python -m flet.cli build macos

# iOS
python -m flet.cli 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.