Skip to content

Lucu-lucuan-Lab/tada-rust

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tada-rust 📖

Asisten Interaktif Belajar Al-Qur'an dari Terminal

tada-rust adalah aplikasi terminal modern (TUI & CLI) untuk membaca, mendengarkan, dan mempelajari Al-Qur'an. Dibangun dengan Rust untuk performa tinggi, aplikasi ini menghadirkan pengalaman membaca Al-Qur'an yang nyaman langsung di terminal Anda dengan dukungan rendering teks Arab yang presisi.

License Rust

Tampilan Awal

✨ Fitur Utama

  • Terminal User Interface (TUI) Modern: Antarmuka satu layar yang kaya fitur menggunakan ratatui.
  • Rendering Teks Arab Presisi: Dukungan penuh untuk reshaping dan bidirectional text (RTL) agar teks Arab tampil benar di terminal.
  • Navigasi Cepat: Pindah antar Surah dan Ayat dengan mudah menggunakan keyboard.
  • Audio Playback: Dengarkan murottal per ayat atau per surah langsung dari aplikasi.
  • Pencarian Canggih: Cari potongan ayat atau terjemahan dengan cepat.
  • Mode Wizard Interaktif: Panduan langkah demi langkah untuk pemula.
  • Bookmark: Simpan ayat favorit Anda untuk dibaca nanti.
  • Offline First: Database dan aset disimpan lokal untuk akses cepat tanpa internet (kecuali streaming audio pertama kali).

🚀 Instalasi

1. Download Binary (Recommended)

Anda tidak perlu menginstal Rust untuk menjalankan aplikasi ini. Cukup unduh binary yang sesuai dengan sistem operasi Anda dari halaman Releases.

  1. Buka halaman Releases.
  2. Unduh file .zip atau .tar.gz yang sesuai (Windows, Linux, atau macOS).
  3. Ekstrak file tersebut.
  4. Jalankan aplikasi tada-rust (Linux/macOS) atau tada-rust.exe (Windows) dari terminal.

2. Build dari Source (Untuk Developer)

Jika Anda ingin mengembangkan atau memodifikasi kode, pastikan Anda telah menginstal Rust & Cargo.

# Clone repository
git clone https://github.com/L2-Lab-Lucu-lucuan-Lab/tada-rust.git
cd tada-rust

# Build dan jalankan
cargo run --release

Persyaratan Font

Untuk pengalaman terbaik, gunakan terminal yang mendukung Ligatures dan karakter Arab dengan baik. Rekomendasi font:

Jika teks Arab terlihat terputus-putus, pastikan terminal Anda menggunakan salah satu font di atas.

📖 Cara Penggunaan

Mode TUI (Default)

Jalankan aplikasi tanpa argumen untuk masuk ke mode TUI:

Jika menggunakan binary:

# Linux / macOS
./tada-rust

# Windows
.\tada-rust.exe

Jika menggunakan source code:

cargo run --release

Kontrol Keyboard (TUI)

Tombol Fungsi
j / Ayat Berikutnya / Kursor Bawah
k / Ayat Sebelumnya / Kursor Atas
n Surah Berikutnya
p Surah Sebelumnya
Spasi Play / Pause Audio
[ / ] Audio Mundur / Maju
s Stop Audio
/ Buka Pencarian
f Tambah Bookmark
Ctrl+b Toggle Sidebar Surah
q Keluar Aplikasi

Mode CLI

Gunakan perintah CLI untuk operasi cepat atau scripting:

# Baca Surah Al-Fatihah (1)
tada-rust read --surah 1

# Cari kata "sabar" dalam terjemahan
tada-rust search "sabar"

# Masuk ke wizard interaktif
tada-rust interactive

🛠️ Pengembangan

Project ini menggunakan arsitektur Clean Architecture yang terbagi menjadi:

  • domain: Core logic dan entity (Surah, Ayah, dll).
  • application: Use cases dan business logic.
  • adapters: Implementasi detail (Database, Audio, TUI).
  • interfaces: Entry points (CLI, TUI).

Menjalankan Test

cargo test

🤝 Kontribusi

Kontribusi sangat diterima! Silakan buat Issue atau Pull Request untuk fitur baru atau perbaikan bug.

📄 Lisensi

Project ini dilisensikan di bawah MIT License.

About

An interactive Rust-powered CLI for reading, exploring, and learning the Qur'an from your terminal.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages