mirror of
https://github.com/nihonbuzz/nihonbuzz-academy.git
synced 2026-01-26 13:32:07 +07:00
feat: update seeder with real YouTube video URLs and update technical blueprint
This commit is contained in:
193
README.md
193
README.md
@@ -1,66 +1,169 @@
|
||||
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
|
||||
# NihonBuzz Ecosystem Blueprint 🇯🇵
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
|
||||
</p>
|
||||
Dokumen ini merupakan cetak biru (blueprint) teknis mutakhir untuk seluruh ekosistem **NihonBuzz**, mencakup arsitektur sistem, infrastruktur, dan model data yang telah dikonsolidasikan.
|
||||
|
||||
## About Laravel
|
||||
---
|
||||
|
||||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
|
||||
## 1. High-Level Architecture
|
||||
|
||||
- [Simple, fast routing engine](https://laravel.com/docs/routing).
|
||||
- [Powerful dependency injection container](https://laravel.com/docs/container).
|
||||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
|
||||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
|
||||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
|
||||
- [Robust background job processing](https://laravel.com/docs/queues).
|
||||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
|
||||
Eksosistem NihonBuzz terbagi menjadi dua entitas utama yang saling terintegrasi namun berjalan di infrastruktur yang dioptimalkan untuk kebutuhan masing-masing.
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
```mermaid
|
||||
graph TD
|
||||
User((User/Student))
|
||||
|
||||
subgraph "Public Interface (nihonbuzz-org)"
|
||||
NextJS["Next.js 16 (React)"]
|
||||
Tailwind["Tailwind CSS"]
|
||||
CF_Pages["Cloudflare Pages + OpenNext"]
|
||||
end
|
||||
|
||||
subgraph "Learning Engine (nihonbuzz-academy)"
|
||||
Laravel["Laravel 12 (PHP 8.3+)"]
|
||||
Inertia["Inertia.js (React Protocol)"]
|
||||
Shadcn["Shadcn UI (Design System)"]
|
||||
Filament["Filament v5 (Jimusho Admin)"]
|
||||
end
|
||||
|
||||
subgraph "Shared Infrastructure"
|
||||
MySQL[("MySQL (UUID Based)")]
|
||||
R2[("Cloudflare R2 (Media Storage)")]
|
||||
OAuth["Google OAuth 2.0"]
|
||||
end
|
||||
|
||||
User --> NextJS
|
||||
User --> Laravel
|
||||
NextJS -.-> OAuth
|
||||
Laravel -.-> OAuth
|
||||
Laravel --> MySQL
|
||||
Laravel --> R2
|
||||
```
|
||||
|
||||
## Learning Laravel
|
||||
---
|
||||
|
||||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
|
||||
## 2. Technical Stack Detail
|
||||
|
||||
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
|
||||
### A. nihonbuzz-org (Marketing & Landing)
|
||||
- **Framework**: Next.js 16.1.4.
|
||||
- **Styling**: Tailwind CSS dengan standar Modern Japanese Aesthetics.
|
||||
- **Infrastructure**: Cloudflare Pages menggunakan adapter **OpenNext** untuk mendukung fitur Server-Side Rendering (SSR) dan API Routes di lingkungan Serverless/Workers.
|
||||
|
||||
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
|
||||
### B. nihonbuzz-academy (Core LMS)
|
||||
- **Backend Core**: Laravel 12.
|
||||
- **Frontend Bridge**: Inertia.js (menghilangkan kebutuhan API terpisah untuk web, menjaga state tetap sinkron).
|
||||
- **UI Architecture**: Shadcn UI yang distandarisasi untuk mencapai kualitas premium dan konsistensi antara Dashboard Siswa dan Panel Manajemen.
|
||||
- **Admin Identity**: Jalur kustom `/jimusho` menggunakan Filament v5 dengan plugin tema Shadcn.
|
||||
|
||||
## Laravel Sponsors
|
||||
---
|
||||
|
||||
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
|
||||
## 3. Security & Access Model (RBAC)
|
||||
|
||||
### Premium Partners
|
||||
Sistem keamanan menggunakan UUID global untuk seluruh entitas dan manajemen peran berbasis **Spatie Permission**.
|
||||
|
||||
- **[Vehikl](https://vehikl.com/)**
|
||||
- **[Tighten Co.](https://tighten.co)**
|
||||
- **[WebReinvent](https://webreinvent.com/)**
|
||||
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
|
||||
- **[64 Robots](https://64robots.com)**
|
||||
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
|
||||
- **[Cyber-Duck](https://cyber-duck.co.uk)**
|
||||
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
|
||||
- **[Jump24](https://jump24.co.uk)**
|
||||
- **[Redberry](https://redberry.international/laravel/)**
|
||||
- **[Active Logic](https://activelogic.com)**
|
||||
- **[byte5](https://byte5.de)**
|
||||
- **[OP.GG](https://op.gg)**
|
||||
```mermaid
|
||||
graph LR
|
||||
subgraph "Management Level (Jimusho Accessibility)"
|
||||
SA[Super Admin] --> A[Admin]
|
||||
A --> B[Bendahara]
|
||||
A --> E[Editor]
|
||||
A --> S[Sensei]
|
||||
end
|
||||
|
||||
subgraph "User Level"
|
||||
ST[Student] --> KK[Ketua Kelas]
|
||||
ST --> AL[Alumni]
|
||||
end
|
||||
|
||||
OAuth((OAuth Integration)) --> ST
|
||||
SA -- "Full Access" --> Laravel
|
||||
```
|
||||
|
||||
## Contributing
|
||||
---
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
## 4. Database Schema Blueprint
|
||||
|
||||
## Code of Conduct
|
||||
Arsitektur database dirancang untuk mendukung "Data Atomik" guna kebutuhan pembelajaran bahasa yang dinamis.
|
||||
|
||||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
||||
```mermaid
|
||||
erDiagram
|
||||
Users ||--o{ Enrollments : has
|
||||
Users ||--o{ SRSReviews : tracks
|
||||
Courses ||--o{ Modules : contains
|
||||
Modules ||--o{ Lessons : contains
|
||||
Levels ||--o{ Courses : categorizes
|
||||
Levels ||--o{ Vocabularies : categorizes
|
||||
Vocabularies ||--o{ SRSReviews : "review_data"
|
||||
|
||||
Users {
|
||||
uuid id PK
|
||||
string name
|
||||
string email
|
||||
timestamp last_activity_at
|
||||
}
|
||||
|
||||
Vocabularies {
|
||||
uuid id PK
|
||||
string word "Kanji/Kana"
|
||||
string reading "Kana only"
|
||||
string meaning_id "Indonesian"
|
||||
string meaning_en "English"
|
||||
string audio_url "Stored in R2"
|
||||
json stroke_order "SVG Logic"
|
||||
}
|
||||
|
||||
## Security Vulnerabilities
|
||||
SRSReviews {
|
||||
uuid id PK
|
||||
timestamp next_review_at
|
||||
int interval
|
||||
float ease_factor
|
||||
}
|
||||
```
|
||||
|
||||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
|
||||
---
|
||||
|
||||
## License
|
||||
## 5. Learning Core Engine
|
||||
|
||||
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
### A. Japanese Support System
|
||||
- **Furigana Engine**: Implementasi tag HTML `<ruby>` di seluruh komponen React untuk manajemen cara baca Kanji otomatis.
|
||||
- **Multi-lingual Context**: Setiap data kosa kata wajib memiliki konteks makna dalam Bahasa Indonesia dan Inggris.
|
||||
- **Media Delivery**: Seluruh aset audio (pronunciation) dan video materi dialirkan (streaming) melalui Cloudflare R2 untuk latensi rendah.
|
||||
|
||||
### B. SRS (Spaced Repetition System)
|
||||
- Menggunakan algoritma pengulangan berjarak (SM-2 based) untuk menghitung `next_review_at` secara individual bagi setiap siswa pada setiap unit kosa kata.
|
||||
- Dashboard siswa menampilkan statistik "Ready to Review" yang diambil secara real-time dari mesin SRS.
|
||||
|
||||
---
|
||||
|
||||
## 6. Advanced Technical Systems
|
||||
|
||||
### A. Gamification Mechanics (Engagement Engine)
|
||||
Sistem dirancang untuk mempertahankan retensi pengguna menggunakan tiga pilar utama:
|
||||
- **XP Ecosystem**: Setiap penyelesaian pelajaran, kuis, atau sesi SRS memberikan unit XP yang meningkatkan level profil siswa.
|
||||
- **Streak System**: Logika harian yang melacak aktivitas beruntun. Absensi aktivitas selama 24 jam akan mereset streak (disertai fitur *Streak Freeze* via shop/metadata).
|
||||
- **Milestone Badges**: Pencapaian otomatis (misal: "N5 Master", "100 Days Warrior") yang disimpan dalam tabel metadata user.
|
||||
|
||||
### B. Media & Asset Pipeline
|
||||
Pengelolaan aset media premium dilakukan secara otomatis menggunakan **Spatie MediaLibrary**:
|
||||
- **Storage**: Integrasi native dengan **Cloudflare R2** via driver S3.
|
||||
- **Processing**: Konversi otomatis format audio ke `.mp3` atau `.ogg` untuk kompatibilitas browser lintas perangkat.
|
||||
- **Security**: Folder `private/pdfs` di R2 digunakan khusus untuk materi berbayar (Paid Content) yang hanya bisa diakses via *Signed URLs* dengan validitas waktu terbatas.
|
||||
|
||||
### C. Monetization & Enrollment Flow
|
||||
Sistem mendukung pembelian kursus secara individual atau berbasis langganan:
|
||||
- **Price Engine**: Mendukung mata uang IDR dengan format desimal yang dioptimalkan untuk gateway pembayaran lokal.
|
||||
- **Access Control**: Relasi `enrollments` menentukan masa aktif akses siswa ke `modules` dan `lessons`. Kursus gratis (Free Preview) dapat diakses tanpa entri di tabel enrollment.
|
||||
|
||||
---
|
||||
|
||||
## 7. Future-Proof & Cross-Platform Strategy
|
||||
|
||||
Arsitektur dikembangkan dengan prinsip **API-Ready** untuk mendukung ekspansi ke aplikasi mobile asli (Bukan Capacitor):
|
||||
|
||||
- **Headless Compatibility**: Meskipun saat ini menggunakan Inertia.js untuk web, seluruh Controller didesain agar mudah di-porting menjadi REST API atau GraphQL untuk konsumsi **React Native**.
|
||||
- **Shared Logic (The Brain)**: Algoritma SRS dan logika validasi kosa kata dipisahkan ke dalam *Service Classes* di Laravel agar bisa melayani permintaan dari Web (Inertia) maupun Mobile App (API) dengan kode sumber yang sama.
|
||||
- **Universal Aesthetics**: Desain sistem Shadcn di Web menjadi referensi utama (tokens) untuk implementasi **NativeWind** di aplikasi mobile guna menjaga visual branding yang identik.
|
||||
|
||||
---
|
||||
|
||||
> **Blueprint Status**: Phase 2 Finalized (Comprehensive).
|
||||
> **Objective**: Membangun ekosistem belajar Bahasa Jepang yang tak tertandingi secara teknis dan estetika.
|
||||
|
||||
Reference in New Issue
Block a user