Portakal CLI 🍊

Portakal is a powerful CLI (Command Line Interface) automation tool that allows you to start your Flutter projects beyond standard defaults, with a "freshly squeezed" and ready-to-use structure.

Leave the tedious tasks to Portakal and enjoy coding! 🧡

---

1. What is it?

Portakal is an advanced project generator built on top of the standard flutter create command. It doesn't just create an empty project; it delivers a project that complies with modern development standards, has necessary packages pre-installed, native settings configured, and the Portakal Framework fully integrated.

In short: "Production-ready infrastructure in a single command."

2. Why Should You Use It?

Portakal handles the settings that would normally take hours in a standard Flutter project in just seconds:

• ⚡ Automatic Package Management: Essential packages like flutter_dotenv, bitsdojo_window, hive, and portakal are added automatically.
• 🪟 Ready-to-Use Native Settings:
  • Windows: C++ files (main.cpp and CMakeLists.txt) are pre-configured for custom window frames and sizing.
  • Android: build.gradle settings, version codes, and signing configurations are ready.
• 🍊 Portakal Core Integration: PManager (State Management), PortakalTheme, and custom UI kits (Button, TextField, etc.) come right at the heart of the project.
• 🚀 Ready Architecture: You start with a clean folder hierarchy via custom_lib and a working example application (BMI Calculator).

3. Who Needs This the Most?

• Serial Developers: Those who are tired of repeating the same setup configurations for every new project.
• Freelancers: Those who want to quickly present a working, stylish, and robust prototype to clients.
• Desktop (Windows) Developers: Those who don't want to deal with changing Flutter's default Windows frame structure.
• Clean Code Enthusiasts: Those who want to start a project with a specific discipline and rule set (rules.md, tasks.md).

---

4. Installation and Adding to PATH

Follow these steps to use Portakal CLI from anywhere in your terminal via the portakal create <project_name> command:

Step 1: Compile the Project

Open a terminal in the directory where generator.dart is located and run the following command:

dart compile exe generator.dart -o portakal.exe

Step 2: Position the Files

Move the generated portakal.exe file, the custom_main.dart file, and the custom_lib folder to a permanent directory (e.g., C:\PortakalTools\).

⚠️ Important: For portakal.exe to work correctly, it must be in the same folder as the template files (custom_lib and custom_main.dart).

Step 3: Add to PATH (Windows)

1. Search for "Edit the system environment variables" in the Start menu and open it.
2. Click the Environment Variables button.
3. Double-click the Path option under System Variables (or User Variables).
4. Click the New button and paste the path of the folder you created in Step 2 (e.g., C:\PortakalTools\).
5. Click OK on all windows to exit.

Step 4: Test It

Open a new terminal and type:

portakal create my_awesome_app

Congratulations! 🍊 You can now squeeze Portakal juice from anywhere.

---

5. Portakal Library

This CLI tool builds your projects upon the Portakal Flutter package. You can check the official package page for details on the library, widget usage, state management with PManager, and theme features:

📦 pub.dev: portakal

---

Develop by JeaFriday! 🧡

---

Portakal CLI 🍊

Portakal, Flutter projelerinizi standartların ötesinde, "taze sıkılmış" ve kullanıma hazır bir yapıyla başlatmanızı sağlayan güçlü bir CLI (Komut Satırı Arayüzü) otomasyon aracıdır.

Angarya işleri Portakal'a bırakın, siz kodlamanın tadını çıkarın! 🧡

---

1. Nedir?

Portakal, standart flutter create komutunun üzerine inşa edilmiş gelişmiş bir proje oluşturucusudur. Sadece boş bir proje oluşturmakla kalmaz; projenizi modern geliştirme standartlarına uygun, gerekli paketleri yüklenmiş, native (yerel) ayarları yapılmış ve Portakal Framework entegre edilmiş şekilde teslim eder.

Kısaca: "Tek komutla, prodüksiyona hazır altyapı."

2. Neden Kullanmalısın?

Sıradan bir Flutter projesi oluşturduğunuzda saatlerce yapmanız gereken ayarları Portakal saniyeler içinde halleder:

• ⚡ Otomatik Paket Yönetimi: flutter_dotenv, bitsdojo_window, hive ve portakal gibi temel paketler otomatik eklenir.
• 🪟 Hazır Native Ayarlar:
  • Windows: C++ (main.cpp ve CMakeLists.txt) dosyaları, özel pencere çerçeveleri ve boyutlandırma için önceden yapılandırılmıştır.
  • Android: build.gradle ayarları, sürüm kodları ve imzalama (signing configs) yapılandırmaları hazırdır.
• 🍊 Portakal Core Entegrasyonu: PManager (State Management), PortakalTheme ve özel UI kitleri (Button, TextField vb.) projenin kalbinde gelir.
• 🚀 Hazır Mimari: custom_lib yapısı ile düzenli bir klasör hiyerarşisi ve çalışan bir örnek uygulama (BMI Hesaplayıcı) ile başlarsınız.

3. Kimlerin Çok İhtiyacı Var?

• Seri Üretim Yapan Geliştiriciler: Sürekli yeni proje açıp aynı ayarları tekrar tekrar yapmaktan sıkılanlar.
• Freelancerlar: Müşterisine hızlıca çalışan, şık ve altyapısı sağlam bir prototip sunmak isteyenler.
• Masaüstü (Windows) Uygulaması Geliştirenler: Flutter'ın varsayılan Windows pencere yapısını değiştirmekle uğraşmak istemeyenler.
• Temiz Kod (Clean Code) Tutkunları: Projeye belirli bir disiplin ve kural setiyle (rules.md, tasks.md) başlamak isteyenler.

---

4. Kurulum ve PATH'e Ekleme

Portakal CLI'ı terminalinizde her yerden portakal create <proje_adi> şeklinde kullanabilmek için aşağıdaki adımları izleyin:

Adım 1: Projeyi Derleyin

generator.dart dosyasının olduğu dizinde terminali açın ve şu komutu çalıştırın:

dart compile exe generator.dart -o portakal.exe

Adım 2: Dosyaları Konumlandırın

Oluşan portakal.exe dosyasını, custom_main.dart dosyasını ve custom_lib klasörünü kalıcı olarak duracağı bir klasöre taşıyın (Örn: C:\PortakalTools\).

⚠️ Önemli: portakal.exe'nin düzgün çalışabilmesi için şablon dosyalarıyla (custom_lib ve custom_main.dart) aynı klasörde olması şarttır.

Adım 3: PATH'e Ekleme (Windows)

1. Başlat menüsüne "Sistem Ortam Değişkenlerini Düzenle" yazın ve açın.
2. Ortam Değişkenleri butonuna tıklayın.
3. Sistem Değişkenleri (veya Kullanıcı Değişkenleri) altındaki Path seçeneğine çift tıklayın.
4. Yeni butonuna basın ve Adım 2'de oluşturduğunuz klasörün yolunu (Örn: C:\PortakalTools\) yapıştırın.
5. Tüm pencerelere Tamam diyerek çıkın.

Adım 4: Test Edin

Yeni bir terminal açın ve şunu yazın:

portakal create my_awesome_app

Tebrikler! 🍊 Artık her yerden Portakal suyu sıkabilirsiniz.

---

5. Portakal Kütüphanesi

Bu CLI aracı, projelerinizi Portakal Flutter paketi üzerine kurar. Kütüphanenin detayları, widget kullanımı, PManager ile state yönetimi ve tema özellikleri için resmi paket sayfasını inceleyebilirsiniz:

📦 pub.dev: portakal

---

Develop by JeaFriday! 🧡#