Skip to content

Commit

Permalink
[#530] Add SwiftUI file organization wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
blyscuit committed Oct 6, 2023
1 parent b581840 commit e6c4a57
Showing 1 changed file with 59 additions and 15 deletions.
74 changes: 59 additions & 15 deletions .github/wiki/Standard-File-Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

To keep all current and upcoming iOS projects aligned, we standardize an iOS project’s file organization by following this below structure:

### Common

```
.
├── README.md
Expand All @@ -15,9 +17,7 @@ To keep all current and upcoming iOS projects aligned, we standardize an iOS pro
│   │   └── LaunchScreen
│   └── Sources
│   ├── Application
│   │   ├── AppDelegate.swift
│   │   ├── Application.swift
│   │   └── SceneDelegate.swift
│   │   └── Varies by UI Interface
│   ├── Constants
│   │   ├── Constants+API.swift
│   │   └── Constants.swift
Expand Down Expand Up @@ -49,18 +49,7 @@ To keep all current and upcoming iOS projects aligned, we standardize an iOS pro
│   │   ├── Authentication
│   │   └── User
│   ├── Presentation
│   │   ├── Modules
│   │   │   ├── Home
│   │   │   └── Login
│   │   ├── Navigator
│   │   │   ├── Navigator+Scene.swift
│   │   │   ├── Navigator+Transition.swift
│   │   │   └── Navigator.swift
│   │   └── Views
│   │   ├── Button
│   │   ├── CollectionView
│   │   ├── TextField
│   │   └── Transition
│   │   └── Varies by UI Interface
│   └── Supports
│   ├── Builder
│   │   └── Builder.swift
Expand Down Expand Up @@ -91,6 +80,7 @@ To keep all current and upcoming iOS projects aligned, we standardize an iOS pro
│   │   └── HomeViewModelProtocolMock+Equatable.swift
│   ├── Specs
│   │   ├── Data
│   │   │   └── Datasources
│   │   │   └── Repositories
│   │   ├── Domain
│   │   │   └── UseCases
Expand Down Expand Up @@ -123,6 +113,60 @@ To keep all current and upcoming iOS projects aligned, we standardize an iOS pro
   └── KIF+Swift.swift
```

### SwiftUI

```
.
└── {ProjectName}
   └── Sources
   ├── Application
   │   ├── {ProjectName}App.swift
   │   └── AppDelegate.swift
   └── Presentation
      ├── Models
           │   └── ProductUIModel.swift
      ├── Coordinators
           │   └── AppCoordinator.swift
      ├── Modules
      │   ├── Home
      │   └── Login
      ├── Styles
      │   └── RoundedButtonStyle.swift
      ├── ViewModifiers
      │   └── View+PrimaryNavigationBar.swift
      ├── Views
      │   └── SearchBarView.swift
      └── ViewIds
         └── ViewId.swift
```

### UIKit

```
.
└── {ProjectName}
   └── Sources
   ├── Application
   │   ├── AppDelegate.swift
   │   ├── Application.swift
   │   └── SceneDelegate.swift
   └── Presentation
      ├── Modules
      │   ├── Home
      │   └── Login
      ├── Navigator
      │   ├── Navigator+Scene.swift
      │   ├── Navigator+Transition.swift
      │   └── Navigator.swift
      └── Views
      │ ├── Button
      │ ├── CollectionView
      │ ├── TextField
      │ └── Transition
      └── ViewIds
         └── ViewId.swift
```

## README.md

`README.md` introduces the overview of the project, for example:
Expand Down

0 comments on commit e6c4a57

Please sign in to comment.