Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capturecontext/basic-ios-template
The template for SwiftPM-based highly modularized (iOS) applications
https://github.com/capturecontext/basic-ios-template
automation best-practices ios modular modularization swift swift-package-manager swiftpm template xcodegen
Last synced: about 24 hours ago
JSON representation
The template for SwiftPM-based highly modularized (iOS) applications
- Host: GitHub
- URL: https://github.com/capturecontext/basic-ios-template
- Owner: CaptureContext
- License: other
- Created: 2022-05-31T22:38:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-14T16:34:41.000Z (about 2 years ago)
- Last Synced: 2023-03-04T16:33:36.223Z (over 1 year ago)
- Topics: automation, best-practices, ios, modular, modularization, swift, swift-package-manager, swiftpm, template, xcodegen
- Language: Swift
- Homepage: https://capturecontext.dev
- Size: 490 KB
- Stars: 32
- Watchers: 0
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# basic-ios-template
[](https://swift.org/download/) [](https://twitter.com/capture_context)
### Getting started
1. Fork the repo as a template.
2. Create a local folder for your app and navigate to it
```bash
mkdir
cd
```
2. Clone the template, rename cloned folder to `App` and navigate to it
```bash
git clone https://github.com//-ios.git
mv -ios App
cd App
```
> You can choose any name or avoid nesting, but we recommend to follow the example (including the case) to get the best result 😌
3. Rename [project.yml](project.yml), [.config/project.yml](.config/project.yml) and [.config/preview.yml](.config/preview.yml) contents accordingly to your needs
- bundleIdPrefix: `org-domain.org-host` to your bundleID prefix
- targets: `MyTarget` to `-ios`
- info.properties.CFBundleDisplayName: `MyApp` to ``
4. Bootstrap the environment
```bash
make bootstrap
```
> See Makefile for details
Than you can commit changes and you are ready for the actual development 😎
```bash
open Package.xcworkspace
```
### Structure
See [Extensions](Extensions/README.md) and [Dependencies](Dependencies/README.md) for more details for these modules
Main work is happenning in the root package.
- `<#Module#>Feature` naming is used for modules user directly interact with
- `<#Service#>` naming modules is used for modules that are used by developers to build feature modules
Basically your `Sources` folder structure will look kinda like this
```swift
Sources { // Main modules
AppFeature // Entry point for the app, contains AppDelegate, RootViewController, AppState etc., coordinates app flows
MainFeature // Main app flow, non-main flows may be Onboarding/Admin/Auth for example.
<#SomeFeature#>Feature // Any other feature
AppUI // App-specific UI components
APIClient // Service module example
Resources // Contains shared resources and generated boilerplate, but you can declare target-specific resources too, see https://github.com/capturecontext/spmgen
}
```
> **Note:**
>
> _Scripts can be improved later so we advice you to keep an eye on the repo and a tracking reference to our `main` branch to keep your infrastructure up to date_ 🚀
### Recommended dependencies
- https://github.com/pointfreeco/swift-composable-architecture
- https://github.com/pointfreeco/swift-identified-collections
- https://github.com/pointfreeco/swift-parsing
- https://github.com/capturecontext/swift-declarative-configuration
- https://github.com/capturecontext/swift-composable-environment
- https://github.com/capturecontext/swift-standard-clients
- https://github.com/capturecontext/swift-capture
- https://github.com/capturecontext/spmgen
- https://github.com/snapkit/snapkit
> Will be recommended later (yet in alpha or beta)
> - https://github.com/capturecontext/composable-architecture-extensions
> - https://github.com/capturecontext/swift-foundation-extensions
> - https://github.com/capturecontext/swift-cocoa-extensions
> - https://github.com/capturecontext/combine-extensions
> - https://github.com/capturecontext/combine-cocoa
> - https://github.com/capturecontext/combine-cocoa-navigation
> - https://github.com/capturecontext/swift-prelude
> - https://github.com/capturecontext/swift-generic-color
> - https://github.com/capturecontext/swift-palette