https://github.com/ml-opensource/swiftui-template-tca
https://github.com/ml-opensource/swiftui-template-tca
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ml-opensource/swiftui-template-tca
- Owner: ml-opensource
- Created: 2023-02-03T08:55:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T09:02:52.000Z (over 1 year ago)
- Last Synced: 2024-06-26T10:31:48.417Z (over 1 year ago)
- Language: Swift
- Size: 1.23 MB
- Stars: 12
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## iOS Project Template for SwiftUI
[](https://developer.apple.com/xcode/)
[](https://swift.org)
[](https://developer.apple.com/ios/)
[](https://github.com/monstar-lab-oss/swiftui-template-tca/actions/workflows/build.yml)
Project template to jumpstart your next iOS project with integrating best practices and tools.
## Motivation
Everytime we create a new project, we do lots of repeated tasks that kills our effective hours.
This template will save those hours and help to follow standard project architecture.
## Best Practices
* [Composable Architecture](https://github.com/pointfreeco/swift-composable-architecture) TCA/Composable Architecture of iOS app using Combine and SwiftUI
* [R.swift](https://github.com/mac-cain13/R.swift) Get strong typed, autocompleted resources like images, fonts and segues in Swift projects
* [Standard gitignore](https://github.com/github/gitignore/blob/master/Swift.gitignore)
* [Moya](https://github.com/Moya/Moya) for netwoking layer
* [Swift-Format](https://github.com/apple/swift-format) [For doing code formatting transformations]
* Development, Staging and Production app flavours
* Separate build configuration for each flavour
### Todo
* Base classes for handling deeplink, notifications and multiple scheme
### Supporting Tools
Xcode 14.0 or later and Swift 5.5 or later.
### Prerequisites:
* [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/installation.html)
Install cookiecutter by runing below terminal command.
```
brew install cookiecutter
```
## Usage
The project template uses Cookiecutter to create your project from it. Run the below command to create your project:
```
cookiecutter git@github.com:monstar-lab-oss/swiftui-template-tca.git
```
Enter your desire app name followed by company name. Thats it, you should be able to see your app directory created based on the template.
## Build Configurations
The templete used `.xcconfig` and `BuildConfiguration.plist` files to maintain different environments(Development/Staging/Production). To know how it is done please follow the [link](https://medium.com/better-programming/how-to-create-development-staging-and-production-configs-in-xcode-ec58b2cc1df4).
## Additional configuration
You will have to manually configure the bundle id of the main target and test target.
## TCA Template Installation
All the Xcode custom template files are located in ~/Library/Developer/Xcode/Templates/ and grouped into sections by folder name. Create a folder with name `Custom Templates` manually or by running the following command from the terminal:
```
mkdir ~/Library/Developer/Xcode/Templates/Custom Templates
```
Now drag and drop the `TCA.xctemplate` that included with the repo to the `Custom Templates` directory. Now the TCA template can be selected from File Templates
## Contributing Code
Please refer to [Contributing Guidelines](https://github.com/monstar-lab-oss/swiftui-template-tca/blob/main/CONTRIBUTING.md) before participating.
## Acknowledgments
* [iOS Project Best Practices and Tools](https://medium.com/@piotr.gorzelany/ios-project-best-practices-and-tools-c46135b8116d)
* [Development, Staging and Production Configs in Xcode](https://medium.com/better-programming/how-to-create-development-staging-and-production-configs-in-xcode-ec58b2cc1df4)
* [iOS Build Management using Custom Build Scheme](https://www.talentica.com/blogs/ios-build-management-using-custom-build-scheme/)
## 👥 Credits
Made with ❤️ at Monstarlab