Dev Setup

👨‍💻 Developer Setup

This page explains how to run Yonky from source and build it into a standalone executable.

---

🛠 Requirements

Before starting, make sure you have the following installed:

• Python 3.11+
• pip (comes with Python)
• Git (optional but recommended)

Required Python packages:

pip install pyqt5 pyinstaller

---

🚧 Running Yonky from Source

1. Clone or download the repository:

   git clone https://github.com/viik2k/yonky.git
   cd yonky

2. Run the app:

   python Yonky.py

This launches the GUI directly using your local Python environment.

---

🔨 Building Yonky to EXE

You can package Yonky into a standalone .exe using pyinstaller:

pyinstaller --onefile --windowed --icon=icon.ico Yonky.py

After the build completes, the executable will be located in the dist/ folder.

Note: Make sure your icon.ico, scripts/ folder, and config.json are present in the same directory as the EXE for full functionality.

---

📂 Recommended Folder Structure

Yonky/
├── Yonky.py
├── icon.ico
├── config.json
├── scripts/
│   ├── example.ps1
│   └── test.bat

---

🧠 Developer Tips

• Make small changes and run python Yonky.py often
• Log outputs or use print() for quick debugging
• Always back up config.json before testing write logic
• Create a dedicated dev/ branch for experiments

---

Pull requests are welcome. Fork the repo, make your changes, and submit a PR with a clear description.