BIN Toolkit

Toolkit Flask untuk validasi dan utilitas BIN + mode desktop (khusus lokal PC kamu).

README ini dibuat detail untuk user Windows, termasuk yang masih pemula.

Project Positioning

BIN Toolkit adalah project utilitas data BIN untuk pembelajaran, pengujian internal, dan automasi workflow teknis yang legal.

Educational and Responsible Use

Project ini ditujukan untuk:

1. Edukasi pengembangan aplikasi Flask.
2. Latihan arsitektur service modular.
3. Validasi data BIN pada skenario yang sah dan berizin.

Project ini tidak ditujukan untuk aktivitas ilegal, penyalahgunaan data, atau akses tanpa izin.

Educational Proposal

Project ini dapat digunakan sebagai materi:

1. Workshop Flask dasar-menengah (routing, blueprint, service layer).
2. Praktik software engineering (struktur modular, dependency management, deployment lokal).
3. Simulasi quality assurance untuk validasi input data.

Target pembelajaran:

1. Peserta mampu setup project Python di Windows dari nol.
2. Peserta memahami alur aplikasi web + desktop wrapper lokal.
3. Peserta memahami batasan etika dan kepatuhan penggunaan data.

License

Project ini menggunakan lisensi MIT. Detail lengkap ada di file LICENSE.

Preview Images

Dashboard utama BIN Toolkit:

1) Yang wajib disiapkan (Windows)

Sebelum menjalankan aplikasi, kamu wajib punya:

1. Windows 10/11
2. Python 3.10+ (disarankan 3.11)
3. Koneksi internet (untuk install dependency)

2) Install Python dari nol (untuk yang belum punya)

Opsi A (paling mudah): download dari website resmi

1. Buka: https://www.python.org/downloads/windows/
2. Download Python versi terbaru (misalnya 3.11.x).
3. Jalankan installer.
4. Penting: centang opsi Add Python to PATH.
5. Klik Install Now.
6. Setelah selesai, tutup installer.

Opsi B (via Winget, jika sudah ada)

Jalankan PowerShell sebagai user biasa:

winget install Python.Python.3.11

3) Cek Python sudah terpasang atau belum

Buka PowerShell, lalu jalankan:

python --version

Kalau tidak tampil versi Python, coba:

py --version

Kalau masih gagal, biasanya Python belum terpasang benar atau PATH belum masuk.

4) Download project

Kalau project sudah ada dalam folder, lanjut ke langkah berikutnya.

Kalau belum, contoh clone dari git:

git clone <URL_REPOSITORY_KAMU>
cd chkme

5) Masuk ke folder project

Contoh:

cd C:\Users\Admin\Desktop\chkme

6) (Disarankan) Buat virtual environment

Virtual environment bikin dependency project rapi dan tidak bentrok dengan project lain.

python -m venv .venv

Aktifkan venv (PowerShell):

.\.venv\Scripts\Activate.ps1

Jika muncul error execution policy, jalankan sekali ini:

Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

Lalu aktifkan lagi venv.

7) Install dependency project

Pastikan posisi terminal ada di folder project, lalu:

pip install -r requirements.txt

Kalau pip tidak dikenali, gunakan:

python -m pip install -r requirements.txt

8) Jalankan aplikasi (mode web)

python launch.py --mode web

Lalu buka browser:

http://127.0.0.1:5000

9) Jalankan aplikasi (mode desktop GUI)

python launch.py

Atau klik file:

start_chkme.bat

Mode desktop akan menjalankan Flask lokal (localhost) lalu membuka app di jendela desktop.

10) Struktur project singkat

• app/: factory aplikasi, config, blueprint HTTP
• modules/: domain logic, service BIN/card
• api/: helper library integrasi API
• templates/: template HTML
• static/: aset CSS/JS
• assets/: database BIN CSV
• server.py: entrypoint server web
• desktop_app.py: launcher desktop lokal

11) Environment variables (opsional)

• CHKME_HOST: host Flask (default: 0.0.0.0)
• CHKME_PORT: port Flask (default: 5000)
• CHKME_DEBUG: 1 atau 0 (default: 1)

Contoh set sementara di PowerShell:

$env:CHKME_PORT="5001"
python launch.py --mode web

12) Troubleshooting (error yang sering terjadi)

1. python is not recognized

   • Install ulang Python dan pastikan centang Add Python to PATH.

2. pip is not recognized

   • Gunakan python -m pip ....

3. ModuleNotFoundError

   • Dependency belum terinstall, jalankan lagi pip install -r requirements.txt.

4. Port 5000 sudah dipakai

   • Ganti port:

     $env:CHKME_PORT="5001"
     python launch.py --mode web

5. Venv tidak bisa aktif di PowerShell

   • Jalankan:

     Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

13) Ringkasan cepat (buat yang pengen langsung jalan)

cd C:\Users\Admin\Desktop\chkme
python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -r requirements.txt
python launch.py --mode web

Lalu buka: http://127.0.0.1:5000