engineering docs

Aori engineering docs

Dokumentasi ini menjelaskan bagaimana aplikasi dalam monorepo berkomunikasi dengan apps/api, bagaimana data dimiliki oleh empat database fisik, dan bagaimana membangun operasi CRUD yang aman.

Prinsip utama

  • UI tidak membaca Prisma atau database secara langsung.
  • apps/api adalah boundary untuk auth, validasi, ownership, rate limit, dan komposisi lintas database.
  • ID lintas database disimpan sebagai scalar reference; relasi tidak otomatis dijamin oleh Prisma.
  • Mutasi harus memiliki session/bearer yang valid dan di-scope dengan organizationId.

Jalur membaca

  1. Pelajari arsitektur monorepo.
  2. Ikuti kontrak API dan panduan CRUD.
  3. Pilih domain database: runner, catalog, commerce, atau inventory.
  4. Gunakan security dan runbooks saat mengubah endpoint.

Source of truth dokumentasi ini adalah router, controller, service, dan Prisma schema di apps/api. Jika endpoint belum ada di source, dokumentasi tidak boleh mengklaim endpoint tersebut tersedia.