This is the iOS SwiftUI Sample App created by adesso Turkey. The project serves as a comprehensive showcase of the best practices in iOS development by utilizing latest available technology. By listing the cryptocurrency market's top coins, the application allows users to see, search and favorite their desired coin to watch it's price change in real time.
- Minimum target of iOS 16
- Usage of Swift concurrency (async/await)
- WebSocket implementation for real-time price change.
- Up-to-date SWiftUI features (Navigation stack etc.)
- Using the new String Catalog
- Using only SPM for package dependencies.
- Able to favorite and save the coins using AppStorage.
- Prerequisites
- Installation
- Brancing Strategy
- Project Structure
- Workspace Preparing
- List of Frameworks
- License
Because tuist is used in this project, there will be no .xcodeproj or .xcworkspace files when it first cloned. To generate them using the tuist manifest files (like Workspace.swift, Project.swift etc.), first run
tuist fetchto fetch swift package dependencies and after that you can run
tuist generateto generate your project. Don't forget to run these tuist commands in the root directory of the project!
Swiftlint can also be installed via included scripts in the repository. Under the {project_root}/scripts/installation directory, simply run:
sh swiftlint.sh
Gitflow is a legacy Git workflow that was originally a disruptive and novel strategy for managing Git branches. Gitflow has fallen in popularity in favor of trunk-based workflows, which are now considered best practices for modern continuous software development and DevOps practices. Gitflow also can be challenging to use with CI/CD.
| Branch | Description |
|---|---|
| Main | In the Git flow workflow, the main branch is used to store code that is release-ready and ready for production. |
| Develop | The develop branch contains pre-production code with recently built features that are currently being tested. It is established at the beginning of a project and maintained during the development process. |
| Feature | You will create a feature branch off the develop branch while working on a new feature, and once it has been finished and carefully reviewed, you will merge your changes into the develop branch. |
| Hotfix | The hotfix branch is utilized in the Git pipeline to swiftly address required changes in your main branch. Your main branch should serve as the base for the hotfix branch, and it should be merged back into both the main and develop branches. |
| Release | The release branch should be used when preparing new production releases. Typically, the work being performed on release branches concerns finishing touches and minor bugs specific to releasing new code, with code that should be addressed separately from the main develop branch. |
- Branch names should start with feature, hotfix or release according to purpose of the branch then should continue with ticket ID. see example: feature/SASU-1234_some-issue
- Pull requests should refer to specific issue with ticketid. see example: [SASU-1234] - New feature
- Merge strategy: Rebase and Merge is preffered for maintaining a linear project history.
| 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, SwifterManager etc. |
| Network/ | Network related implementations will be defined here. This will include endpoint builders to use cases. |
| Scenes/ | Application related scenes will be defined here, such as routing, UI implementations etc. |
| Utility/ | Utilities includes extensions, final classes and other resources. |
| Resources/ | Images, icons, assets, fonts, Mocks, Localization... |
- 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
- If you wish to silence App Store Connect's "Encryption Ask" or don't use any external encryption in your project, you can define
ITSAppUsesNonExemptEncryptionkey asNOin the Info.plist. Learn more in here
| 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. |
| SwiftLog | Logging API for Swift that works well with compatible API's. |
| Maestro | Flexible UI test automation tool. |
- tuist - Tuist is a command line tool that helps you generate, maintain and interact with Xcode projects. It's open source and written in Swift.
- 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.
- GithubActions - CI/CD faeature to build, test, and deploy your code right from GitHub.
- Figma Link - UI design files for the project.
- Open Issues
Act now to join our team and become an adessi — enjoy a Great Place to Work!
Copyright 2023 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.