Skip to content

Commit c66b1f0

Browse files
ersinaksarersinaksar
committed
Add documentation and localization files
1 parent a0ff5f7 commit c66b1f0

13 files changed

+147
-12
lines changed

‎README-CN.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 项目文档
2+
3+
🌐 [English](README.md) | [Türkçe](README-TR.md)
4+
5+
此项目遵循 Clean Architecture 原则并使用 Flutter。
6+
7+
## 文件结构
8+
- **lib/app/**: 全局配置、路由和根组件。
9+
- **lib/core/**: 公共提供程序、帮助程序和常量。
10+
- **lib/features/**: 按层划分的功能模块。
11+
- **lib/main.dart**: 应用程序入口点。
12+
13+
<!-- 详细说明请参考:
14+
- [Clean Architecture](docs/architecture.md)
15+
- [Riverpod 使用方法](docs/riverpod_usage.md)
16+
- [Firebase 集成](docs/firebase_integration.md) -->

‎README-TR.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Proje Dokümantasyonu
2+
3+
🌐 [English](README.md) | [中文](README-CN.md)
4+
5+
Bu proje, Clean Architecture prensiplerini takip eder ve Flutter kullanır.
6+
7+
## Dosya Yapısı
8+
- **lib/app/**: Uygulama genelindeki yapılandırmalar, rotalar ve kök widget.
9+
- **lib/core/**: Sağlayıcılar, yardımcı sınıflar ve sabitler.
10+
- **lib/features/**: Katmanlara ayrılmış özellikler veya modüller.
11+
- **lib/main.dart**: Uygulamanın giriş noktası.
12+
13+
Ayrıntılı açıklamalar için:
14+
- [Clean Architecture](docs/architecture.md)
15+
- [Riverpod Kullanımı](docs/riverpod_usage.md)
16+
- [Firebase Entegrasyonu](docs/firebase_integration.md)

‎README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# flutter_high_level_project_structure
1+
# Project Documentation
22

3-
A new Flutter project.
3+
🌐 [Türkçe](README-TR.md) | [中文](README-CN.md)
44

5-
## Getting Started
5+
This project follows Clean Architecture principles and uses Flutter.
66

7-
This project is a starting point for a Flutter application.
7+
## File Structure
8+
- **lib/app/**: Global configurations, routes, and the root widget.
9+
- **lib/core/**: Common providers, helpers, and constants.
10+
- **lib/features/**: Features or modules divided into layers.
11+
- **lib/main.dart**: Entry point of the application.
812

9-
A few resources to get you started if this is your first Flutter project:
10-
11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
13-
14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
13+
For detailed explanations, refer to:
14+
- [Clean Architecture](docs/architecture.md)
15+
- [Riverpod Usage](docs/riverpod_usage.md)
16+
- [Firebase Integration](docs/firebase_integration.md)

‎docs/en/architecture.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Clean Architecture
2+
3+
## Layers
4+
5+
### Presentation Layer
6+
- Widgets, Pages, and UI components.
7+
8+
### Application Layer
9+
- State Notifiers, Providers, and business logic.
10+
11+
### Domain Layer
12+
- Entities, Use Cases, and core business rules.
13+
14+
### Infrastructure Layer
15+
- Repository Implementations, Data Sources, and external service integrations.

‎docs/en/firebase_integration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Firebase Integration
2+
The firebase_core and firebase_messaging packages are used.
3+
Firebase is initialized using the initializeFirebase() function.
4+
Firebase-related providers are defined under core/providers.

‎docs/en/navigation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Navigation and Routes
2+
Navigation management is handled using the go_router package.
3+
Routes are centrally managed using app_router.dart and routes.dart files.

‎docs/en/riverpod_usage.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
## Riverpod Usage
3+
State management is provided using StateNotifierProvider and ConsumerWidget.
4+
ProviderScope ensures that providers can be accessed globally throughout the application.

‎docs/en/structure.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# File Structure
2+
3+
## lib/app/
4+
Contains global configurations, routes, and the root widget of the application.
5+
6+
## config/
7+
Holds application settings and theme configurations.
8+
9+
## navigation/
10+
Manages route definitions and navigation settings.
11+
12+
## app.dart
13+
The main widget of the application.
14+
15+
## lib/core/
16+
Common providers, helper classes, and constants used throughout the application.
17+
18+
## lib/features/
19+
Features or modules of the application. Each feature is divided into:
20+
- **presentation/**: Widgets, Pages, and UI components.
21+
- **application/**: State Notifiers, Providers, and business logic.
22+
- **domain/**: Entities, Use Cases, and core business rules.
23+
- **infrastructure/**: Repository Implementations, Data Sources, and external service integrations.
24+
25+
## lib/main.dart
26+
Entry point of the application.

‎docs/tr/architecture.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Clean Architecture Katmanları
2+
3+
### **Presentation Layer (Sunum Katmanı)**
4+
Widgets, Pages ve UI bileşenleri buradadır.
5+
6+
### **Application Layer (Uygulama Katmanı)**
7+
State Notifiers, Providers ve iş mantığı burada bulunur.
8+
9+
### **Domain Layer (Alan Katmanı)**
10+
Entities, Use Cases ve temel iş kuralları burada tanımlanır.
11+
12+
### **Infrastructure Layer (Altyapı Katmanı)**
13+
Repository Implementations, Data Sources ve harici servis entegrasyonları burada yer alır.

‎docs/tr/firebase_integration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Firebase Entegrasyonu
2+
firebase_core ve firebase_messaging paketleri kullanılır.
3+
initializeFirebase() fonksiyonu ile Firebase başlatılır.
4+
Firebase ile ilgili sağlayıcılar core/providers altında tanımlanır.

0 commit comments

Comments
 (0)