Smart Adisyon Dokümantasyonuna Hoş Geldiniz 👋
Bu site, Smart Adisyon POS sisteminin merkezi ekip dokümantasyonudur. Sistemin nasıl çalıştığını, mimari kararları, ekranları ve değişiklik geçmişini tek bir yerde toplar.
Yeni katıldıysanız doğru yerdesiniz; kod yazmadan önce buradan başlayın.
Smart Adisyon nedir?
Smart Adisyon, restoranların sipariş, ödeme, mutfak ve yazdırma süreçlerini yöneten bir POS sistemidir. Sistem dört repodan oluşur:
| Repo | Rolü |
|---|---|
smart_menu_adisyon_ui | Flutter istemcisi: POS, Garson, KDS ve Yazıcı uygulama rolleri |
smart-menu-adisyon-backend-dev | Go backend: sipariş, ödeme, mutfak, yazdırma |
smart-menu-adisyon-localdb-dev | Restorandaki yerel Postgres şeması, migration’lar ve seed’ler |
smart-menu-adisyon-admin-panel | Next.js yönetim paneli |
Bu dokümantasyon kimin için?
- Geliştiriciler: Bir servisin nasıl çalıştığını ve neden öyle tasarlandığını öğrenmek için.
- Yeni ekip üyeleri: Sisteme hızlıca alışmak için.
- Ürün ve test ekibi: Ekranların ve akışların güncel davranışını görmek için.
Nereden başlamalı?
- Genel bakış: yönetim panelinin sistemdeki yeri, kullanılan teknolojiler, komutlar
- Rotalar ve kabuk: URL yapısı ve sayfa iskeleti
- Ekranlar: her ekranın davranışı
- Tasarım sistemi: token’lar ve ortak bileşenler
- Veri ve entegrasyon: veri kaynakları ve backend bağlantıları
- Dokümantasyon düzeni: bu dokümanların nasıl yazıldığı ve güncellendiği
- Değişiklik günlüğü: son değişiklikler
Katkıda bulunmak
Dokümantasyon, kodla birlikte yaşar. Her servis reposundaki docs/ klasörü,
kod değişikliğiyle aynı commit’te güncellenir ve bu siteye aktarılır.
Kuralların ayrıntısı Dokümantasyon düzeni
sayfasındadır.
Bir sayfada eksik ya da yanlış bir bilgi görürseniz ilgili repoda düzeltin.
Last updated on