Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/GoodRequest/Temple

🗂️ This repository provides a guide to creating Xcode templates for iOS boilerplate code to save time and increase creativity in development. It simplifies the process and helps new team members get up to speed. A solution to Xcode's poorly documented templates.
https://github.com/GoodRequest/Temple

boilerplate library swift template xcode

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/GoodRequest/Temple
Owner: GoodRequest
License: mit
Created: 2021-01-28T13:30:06.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-07-07T07:07:54.000Z (over 1 year ago)
Last Synced: 2024-08-02T06:23:23.629Z (3 months ago)
Topics: boilerplate, library, swift, template, xcode
Language: Swift
Homepage:
Size: 3.22 MB
Stars: 32
Watchers: 4
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

fucking-awesome-swift - Temple - 🗂️ Most advanced project and file templates. (Libs / UI)
awesome-swift - Temple - 🗂️ Most advanced project and file templates. (Libs / UI)

README

        # 🕍 Xcode templates 

[![iOS Version](https://img.shields.io/badge/iOS_Version->=_13.0-brightgreen?logo=apple&logoColor=green)]() [![Swift Version](https://img.shields.io/badge/Swift_Version-5.2-green?logo=swift)](https://docs.swift.org/swift-book/)

If you are like me you love writing iOS code but there is nothing that breaks your creativity more than boilerplate code and having to think about it while some other more creative solutions might reside in your mind at the same time. Even if you have a pretty good idea about your architecture it is surely a waste of time to write boilerplate since it’s just repeating code. All you need is a bunch of good templates and writing code in any architecture should be easier for you as well and easier to get into for new members of the team. But it has a catch. Xcode templates aren’t exactly what you would call a well-documented part of the tool. That is why I decided to bring you through the process of building these from scratch to save you the trouble I went through with collecting the knowledge on this subject.

Writing templates has these advantages:

- Makes you save time in the long run if you take time to maintain and write your templates well

- It takes less time to onboard new people because they will not work from scratch 

- It helps maintain code conventions that you set up for yourself and your team

- If you ever wanted to export your snippets you’ll notice one similarity with templates and that is that they are saved locally and outside of any project that you are working on. That means that it's a great opportunity to upload those to a repository to be able to share them or to change your workstation while keeping up to date.

## Table of content

* [File templates](File%20Templates/)

    * [MVVM Screen](File%20Templates/Storyboard%20UITemplates/View%20Model%20Controller.xctemplate/)

    * [Reactor storyboard screen](File%20Templates/Storyboard%20UITemplates/Reactor%20Controller.xctemplate/)

    * [Reactor code based screen](File%20Templates/Code%20UI%20BasedTemplates/Reactor%20Controller.xctemplate/)

    * [Other templates](File%20Templates/Other%20Templates/)

        * [Manager template](File%20Templates/Other%20Templates/Manager.xctemplate/)

        * [Endpoint template](File%20Templates/Other%20Templates/Endpoint.xctemplate/)

        * [Coordinator template](File%20Templates/Other%20Templates/Coordinator.xctemplate/)

* [Project template](Project%20Templates/Custom/)

    * [Contains xcConfigs](Project%20Templates/Custom/Good%20Project.xctemplate/Resources/Configs/)

    * [Cocoa pods](https://bitbucket.org/GoodRequest/temple/src/master/Project%20Templates/Custom/Good%20Cocoa.xctemplate/)

    * [Fastlane](Project%20Templates/Custom/Good%20Lane.xctemplate/)

    * [Firebase](Project%20Templates/Custom/Good%20Firebase.xctemplate/)

    * [Licences from settings](Project%20Templates/Custom/Good%20Licence.xctemplate/)

* [Target templates](Target%20Templates/)

    * [swiftlint autocorrect aggretate](Target%20Templates/Swiftlint%20Target.xctemplate/TemplateInfo.plist)

    * [anylint autocorrect aggretate](Target%20Templates/Anylint%20Target.xctemplate/TemplateInfo.plist)

    * [firebase config plist linker aggregate](Target%20Templates/Firebase%20Config%20Linker%20Target.xctemplate/TemplateInfo.plist)

* [Installation](#installation)

* [Create your own templates](#create-your-own-templates)

* [License](#license)

    

#warning: all templates are dependent on GoodrequestIOSExtensions, that you can fetch with SPM from: https://github.com/GoodRequest/GoodIOSExtensions

## Installation

First of all if you want to connect template to your template list you have to find the right folder to clone the repo.

Directory where you can add custom templates so they are visible in your template list in xcode:

```

/Users/$USER_NAME/Library/Developer/Xcode/Templates

```

### Git clone

Go to the folder and clone the the git repo contents

```

/Users/$USER_NAME/Library/Developer/Xcode/Templates

```

### Copy paste

Alternativelly you can copy the project templates and paste thme in the folder

```

/Users/$USER_NAME/Library/Developer/Xcode/Templates

```

## Create your own templates

Also if you want to create your own take inspiration from the already existing ones.

Directory where to find already existing Xcode templates to take inspiration from:

```

/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File

```

## Loading Dependencies with SPM

The template automatically generated build tools package. What you want to do now is to connect it to the project as a local package. 

1. **Open** the **Package.swift** you your **project root** and **uncomment** the package.swift. This will cause a compile error, but only because its still now added as a defacto package despite the fact that it is already in the right place in the project.

2. **Delete** the **reference** to these two package files.

3. Now you want to **add** a **local package** of good dependencies. Open the add package prompt for the project and click add local project. Point to the packages folder in the project root and find good dependencies. Once you select them hit add package and you are good to go

![Logo](Resources/dependencies.gif)

4. As soon as the packages are fetched add the package as framework

![Logo](Resources/frameworks.png)

### External Dependencies

All external dependencies should be primarily added via SPM via a local package or the projects package interface. It’s up to you which method you choose.

## License

GoodIOSExtensions repository is released under the MIT license. See [LICENSE](LICENSE.md) for details.