Standard File Organization

Goal 🏆

The goal is to standardize the file organization in a project. In order to keep all projects in alignment, please arrange the folder structure similar to the following organization.

Standard file organization 🗂

ROOT
├─ README.md
├─ Sources
   ├─ Application
     ├─ AppDelegate
     ├─ Constants
     ├─ Entitlements
     ├─ Localizations
     ├─ Resources
   ├─ Extensions
   ├─ Models
   ├─ Modules
   ├─ Protocols
   ├─ Services
      ├─ Network
      ├─ ...
   ├─ Utilities
      ├─ Logger
      ├─ ...
   ├─ Views
├─ Tests
   ├─ Unit Tests
   ├─ UI Tests

README.md

README.md file is supposed to be the first file that is opened when opening the project.

It is nice to provide developers an overview of the whole project.

For example:

- What we do
- What is the main feature of the project
- How to set up the project
- ...

This README.md file is optional.

Sources

This folder contains the main source code of the project.

Tests

This folder contains the testing code of the project.

There are two main types of testing:

• Unit Testing
• UI Testing.

Note: In terms of the detailed implementation inside Unit Tests and UI Tests folders, you can define a specific way for your project. In this wiki, we just generalize the top lever folder structure.

For example: I create subfolders to test for `Modules`, `Services`, etc. as same as what I have in `Sources` folder.

├─ Tests
   ├─ Unit Tests
      ├─ Modules
      ├─ Services
      ├─ ...

For example: I try to split the testing flow and the test usecases into `Testing flow` and `Testing usecases` folder.

├─ Tests
   ├─ UI Tests
      ├─ Testing flows
      ├─ Testing usecases
      ├─ ...

Where to go from here 🚥