Mengenal sebuah monorepo engineering

FM Lab Monorepo

Ruang kerja jangka panjang untuk mempelajari software engineering modern, menguji gagasan secara terpisah, dan hanya mempertahankan yang terbukti bermanfaat. Portofolio hanyalah hasil sampingan; yang utama adalah catatan engineering-nya.

54 milestone yang dikerjakan berurutan · 49 keputusan tercatat · 27 workspace

Pelajari → Uji coba → Bakukan

Aturan adopsi teknologi di repositori ini, dan bagaimana aturan itu dijalankan dalam praktik.

  1. Pelajari

    Sebuah teknologi baru masuk bila ada tujuan belajar atau tanggung jawab engineering yang jelas, dan semuanya tercatat dalam milestone dan keputusan.

  2. Uji coba

    Aturan ini menyediakan labs/ untuk eksperimen terpisah, tetapi saat ini labs/ berisi 0 workspace. Eksperimen justru dibangun sebagai 4 workspace playground yang berdiri sendiri dan sebagai vertical slice produk yang mandiri.

  3. Bakukan

    Kode baru dijadikan paket bersama setelah ada produk kedua yang membutuhkannya. Kapabilitas seperti storage dan search diekstrak dari vertical slice yang sudah berjalan, bukan dirancang sejak awal.

Perjalanan engineering

Tiga fase dalam satu garis. Setiap titik adalah satu milestone sesuai urutan pengerjaannya; jaraknya menunjukkan urutan, bukan waktu.

  1. Fase 1

    Fondasi dan ekosistem dokumentasi

    M0 sampai M7.1

    Fondasi repositori dan ekosistem dokumentasi: satu platform immutable, paket SDK publik, dan aplikasi yang dibangun di atasnya.

    40 milestone · 11 workspace baru · 35 keputusan
  2. Fase 2

    Vertical slice produk

    M8.0 sampai M8.4

    Vertical slice produk yang mandiri. Kapabilitas bersama baru diekstrak setelah terbukti dibutuhkan oleh lebih dari satu produk.

    5 milestone · 7 workspace baru · 5 keputusan
  3. Fase 3

    Keragaman framework dan runtime

    M9.0 sampai M10.1 · masih berjalan

    Batasan yang sama diuji pada framework, runtime, dan bahasa lain, ditambah design token yang tidak terikat pada framework mana pun.

    9 milestone · 9 workspace baru · 9 keputusan

Lihat semua milestone

Arsitektur

Dependensi mengalir satu arah. Aplikasi memakai paket, paket tidak pernah memakai aplikasi, dan playground berdiri sendiri.

12 aplikasi · 11 paket · 4 playground

Buka peta arsitektur

Mulai membaca dari mana

Empat jalur membaca dokumentasi, masing-masing untuk jenis pembaca yang berbeda.

Pengunjung portofolio

5 dokumen

Apa isi repositori ini dan mengapa bentuknya seperti ini, dalam sekitar lima menit.

  1. Architecture OverviewCatatan arsitektur · docs/architecture/overview.md
  2. Adopt a Vertical Slice StrategyKeputusan · ADR-036
  3. Prefer Delayed Extraction Across Vertical SlicesKeputusan · ADR-037
  4. M8.2 Shared Foundations Acceptance ReviewTinjauan penerimaan · docs/acceptance/M8.2-shared-foundations-review.md
  5. Introduce a Derived Repository AtlasKeputusan · ADR-049

Engineer

9 dokumen

Batasan, keputusan, dan cara kapabilitas diekstrak tanpa ikut membagi perilaku produk.

  1. Dependency RulesCatatan arsitektur · docs/architecture/dependency-rules.md
  2. Documentation SystemCatatan arsitektur · docs/architecture/documentation-system.md
  3. Build One Immutable Documentation PlatformKeputusan · ADR-005
  4. Adopt a Vertical Slice StrategyKeputusan · ADR-036
  5. Prefer Capability Extraction Over Framework ExtractionKeputusan · ADR-038
  6. Preserve Domain Ownership Across Shared CapabilitiesKeputusan · ADR-039
  7. Prefer Framework-Neutral CapabilitiesKeputusan · ADR-041
  8. Shared FoundationsPanduan · docs/guides/shared-foundations.md
  9. Notes Vertical Slice ArchitecturePanduan · docs/guides/notes-architecture.md

Kontributor

4 dokumen

Instal, jalankan, validasi, dan ubah repositori.

  1. ContributingPanduan repositori · CONTRIBUTING.md
  2. Contribution WorkflowPanduan · docs/guides/contribution-workflow.md
  3. Development ServersPanduan · docs/guides/development-servers.md
  4. Documentation WorkflowPanduan · docs/guides/documentation-workflow.md

Pengguna Documentation SDK

4 dokumen

Mulai memakai paket dokumentasi publik; pembahasan lengkapnya ada di Documentation Website.

  1. Getting Started with Repository DocumentationPanduan · docs/guides/getting-started-documentation.md
  2. Documentation SDK API ReferencePanduan · docs/guides/documentation-sdk-api-reference.md
  3. Documentation Package ReferencePanduan · docs/guides/documentation-packages-reference.md
  4. Documentation Extension ContractsPanduan · docs/guides/documentation-extension-contracts.md

Teknologi

Bahasa, runtime, dan framework persis seperti yang dideklarasikan di manifest, tanpa menebak versi.

Bahasa
  • TypeScript
  • C#
  • Python
Runtime
  • Node.js
  • Bun
  • Deno
  • .NET
Framework dan library
  • Astro
  • Next.js
  • SvelteKit
  • Vite
  • ASP.NET Core
  • FastAPI
  • Nuxt

Lihat matriks teknologi lengkap

Menjalankan secara lokal

Setiap server pengembangan memakai port tetap dan menolak berjalan bila port itu sedang dipakai, alih-alih pindah ke port lain.

Prasyarat

  • Node.js 24.18.0, sesuai .nvmrc
  • pnpm@11.15.1, disediakan oleh Corepack
  • Khusus untuk playground: Bun, Deno, .NET 10.0, Python >=3.13,<3.14

Instalasi

Jalankan sekali saja dari root repositori.

nvm use corepack enable pnpm install

Perintah utama

  • pnpm devMenjalankan server pengembangan Atlas.
  • pnpm dev:atlasSama dengan pnpm dev, dengan nama yang lebih eksplisit.
  • pnpm dev:allMemeriksa semua prasyarat, lalu menjalankan seluruh server pengembangan. Tidak ada yang dijalankan bila satu pemeriksaan gagal.

Jalankan satu workspace dengan pnpm --filter <workspace> dev.

Semua perintah dan port

Keputusan engineering

Ada 49 keputusan arsitektur yang tercatat. Delapan keputusan berikut paling menjelaskan repositori ini.

  1. ADR-005
    Build One Immutable Documentation Platform

    Satu objek platform immutable menjadi tulang punggung yang dibaca oleh semua alat dokumentasi.

  2. ADR-019
    Introduce a Documentation SDK

    Satu SDK tingkat tinggi menjadikan paket internal sebuah produk yang siap dipakai pihak lain.

  3. ADR-036
    Adopt a Vertical Slice Strategy

    Produk dibangun utuh sebagai vertical slice, bukan lapis demi lapis.

  4. ADR-037
    Prefer Delayed Extraction Across Vertical Slices

    Kode bersama baru diekstrak setelah produk kedua benar-benar membutuhkannya.

  5. ADR-038
    Prefer Capability Extraction Over Framework Extraction

    Yang dibagikan adalah kapabilitas seperti storage dan search, bukan kode framework.

  6. ADR-044
    Introduce Runtime Independence Validation

    Kemandirian dari runtime tertentu diuji dengan layanan nyata, bukan sekadar diasumsikan.

  7. ADR-048
    Introduce Framework-Neutral Design Tokens

    Konsistensi visual dibangun dari token yang tidak terikat framework, bukan dari pustaka komponen bersama.

  8. ADR-049
    Introduce a Derived Repository Atlas

    Atlas ini menurunkan inventarisnya dari repositori alih-alih memelihara salinan.

Lihat semua keputusan

Tiga situs, satu sumber dokumen

Atlas, Documentation Website, dan Knowledge Hub membaca dokumen yang sama untuk pembaca yang berbeda.

Orientasi

@fm/atlas

Anda di sini

Membantu pembaca baru memahami isi repositori, perjalanannya, dan bacaan berikutnya. Semua daftar di dalamnya diambil langsung dari repositori saat situs di-build.

Jalankan lokal: pnpm --filter @fm/atlas dev · http://127.0.0.1:3308
Dokumentasi SDK

@fm/documentation-site

Dokumentasi produk untuk Documentation SDK. Situs ini menampilkan seluruh dokumen kanonis, lengkap dengan pencarian, graf relasi, dan panduan upgrade, memakai SDK publik yang sama dengan yang didokumentasikannya.

Jalankan lokal: pnpm --filter @fm/documentation-site dev · http://127.0.0.1:3301
Buku panduan

@fm/knowledge-hub

Buku panduan: sekumpulan kecil dokumen pilihan yang menghubungkan gagasan engineering dengan keputusan dan kode di repositori.

Jalankan lokal: pnpm --filter @fm/knowledge-hub dev · http://127.0.0.1:3300