Berkontribusi
Cara menyiapkan repositori PaperPindai, menambah halaman Docs, dan mengirim PR.
Prasyarat
- Node.js 20 atau lebih baru, atau Bun.
- Git.
- Pemahaman dasar React dan TypeScript untuk perubahan kode.
Struktur repositori
PaperPindai adalah satu repositori dengan satu aplikasi Next.js di root. Route landing, Docs, Scan, dan Admin dilayani app yang sama. Kode Docs berada di src/features/docs/; android/ adalah aplikasi Flutter terpisah.
PaperPindai/
├── src/
│ ├── app/ # route Next.js untuk /, /docs, dan /scan
│ ├── features/
│ │ ├── landing/ # implementasi landing
│ │ ├── docs/ # halaman, komponen, API, dan konten Docs
│ │ ├── scan/ # UI, modul browser, dan worker Scan
│ │ └── admin/ # dashboard privat dan autentikasi Admin
│ ├── components/ui/ # komponen UI bersama
│ └── lib/ # kemampuan yang digunakan lintas fitur
├── prisma/schema.prisma # schema PostgreSQL bersama
├── messages/ # terjemahan UI id dan en
├── android/ # aplikasi FlutterFile route di src/app/docs/ adalah wrapper App Router. Implementasi halaman, komponen, loader MDX, webhook, dan artikel berada di src/features/docs/.
Menjalankan proyek secara lokal
# 1. Install dependensi dari root repository
bun install
# 2. Isi environment lokal sesuai .env.example dengan nilai development
# 3. Jalankan satu app Next.js
bun run devLanding tersedia di /, Docs di /docs, dan scanner di /scan. Gunakan database PostgreSQL development yang sesuai dengan .env.example. Jangan arahkan perintah migrasi atau reset development ke database production.
Sebelum mengirim perubahan, jalankan pemeriksaan yang relevan dari root:
bun run lint
bun run typecheck
bun run test
bun run buildUntuk perubahan skema, ikuti instruksi AGENTS.md dan gunakan migrasi Prisma pada database development.
Menambah atau mengubah halaman Docs
Artikel statis Docs adalah file MDX di src/features/docs/models/content/. Untuk menambah halaman:
- Buat file
nama-halaman.mdxdi folder tersebut. - Isi frontmatter dengan
title,slug,order,description, danupdated. - Tulis konten dengan heading
##dan###; heading tersebut masuk ke daftar isi.
---
title: Judul Halaman
slug: judul-halaman
order: 6
description: Satu kalimat untuk ringkasan halaman dan meta description.
updated: 2026-11-03
---
## Bagian pertama
Konten di sini.Urutan sidebar dibaca dari order pada frontmatter. Komponen MDX yang tersedia mencakup Callout dengan tipe info, warning, danger, success, dan tip, serta code block dengan syntax highlighting.
Konten ditulis dalam Bahasa Indonesia
Tulis artikel Docs terutama dalam Bahasa Indonesia. Teks antarmuka seperti sidebar, navbar, dan pesan kosong berada di messages/id.json dan messages/en.json.
Gaya kode dan konten
- Ikuti konvensi TypeScript dan React yang sudah ada; jangan menambah
anybaru. - Gunakan komponen UI bersama dan Lucide untuk ikon; jangan memakai emoji di UI.
- Hindari karakter em dash pada kode dan konten.
- Jaga kontras WCAG AA pada mode terang dan gelap, termasuk code block dan callout.
- Perubahan visual diuji pada lebar layar mobile dan desktop.
Melaporkan bug dan mengusulkan fitur
Gunakan GitHub Issues. Sertakan versi browser dan sistem operasi, langkah reproduksi, hasil yang diharapkan dan aktual, serta screenshot atau rekaman layar bila relevan. Untuk usulan fitur, jelaskan masalah yang ingin diselesaikan.
Mengirim pull request
- Periksa Issue yang relevan atau buat Issue untuk perubahan yang memerlukan diskusi.
- Buat branch dari
mainterbaru dan jaga perubahan tetap fokus. - Jalankan lint, typecheck, test, dan build yang relevan dari root.
- Jelaskan perubahan, validasi, dampak data, dan hubungkan Issue terkait di deskripsi PR.
- Tunggu review sebelum perubahan digabungkan.
Jika menggunakan workflow repository atau coding agent, ikuti aturan AGENTS.md root untuk worktree, Issue, commit, dan PR.