iOS Boilerplate
This is the iOS boilerplate created by Adesso Turkey for new projects using Swift 5. The project's primary objective is to help the development of a new one to kick-start the environment with configurations, the required features used in common Adesso projects, and the helpful functionalities.
Table of Contents
Prerequisites
- MacOS Big Sur (11.5 or higher)
- Xcode 13 or higher ~ Swift 5.0
- Swiftlint - To Install SwiftLint, please check Swiftlint Installation section from read me file
Swiftlint Installation
- On the directory of
{project_root}/scripts/installation, via terminal- run
sh swiftlint.shto install brew (if necessary) and swiftlint.
- run
Project Structure
| Name | Description |
|---|---|
| Application/Services/ | Application based services will be defined here, such as logging, network, server... |
| Configs/ | Everything relative to build and environment configuration will be defined here |
| Managers/ | Managers will be put here such as LoggerManager, UtilityManager... |
| Network/ | Network related implementations will be defined here. You can find network related developments under feature/adesso-network branch. If you want to use it, you can merge it to develop easily. |
| Scenes/ | Application related scenes will be defined here, such as navigation viewcontrollers, storyboards... |
| Utility/ | Extensions, final classes etc. will be putt here |
| Resources/ | Images, icons, assets, fonts, Mocks, Localizable.strings... |
Workspace Preparing
- On the directory of
{project_root}/scripts/installation, via terminal- run
./rename-project.swift "$NEW_PROJECT_NAME"to change project name. - run
sh install-githooks.shto install git-hooks into your project. Includes following git hooks; Git hooks include SwiftLint validation, git message character limitation and issue-id check- pre-commit: This hook provides swiftlint control to detect errors quickly before commit.
- commit-msg: This hook checks that messages must have a minimum 50 characters. It also tells it should contain an issue tag. Ticket id must be between square brackets and [ticketid] separated by hyphens. See example: "[ISSUE-123] commit message" or "[JIRA-56] - commit message"
- run
List of Frameworks
| Framework | Description |
|---|---|
| SwiftLint | A tool to enforce Swift style and conventions. |
| Pulse | Pulse is a powerful logging system for Apple Platforms. Native. Built with SwiftUI. |
| CocoaLumberjack | Powerful & flexible logging framework. |
Useful Tools and Resources
- SwiftLint - A tool to enforce Swift style and conventions.
- TestFlight - TestFlight beta testing lets you distribute beta builds of your app to testers and collect feedback.
- Appcenter - Continuously build, test, release, and monitor apps for every platform.
Join the crew!
Act now to join our team and become an adessi — enjoy a Great Place to Work!
License
Copyright 2020 adesso Turkey
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.