https://github.com/karhoo/karhoo-ios-ui-sdk
iOS UI SDK for Karhoo
https://github.com/karhoo/karhoo-ios-ui-sdk
cd-deployment cicd ignore-curator team-mobile
Last synced: 6 months ago
JSON representation
iOS UI SDK for Karhoo
- Host: GitHub
- URL: https://github.com/karhoo/karhoo-ios-ui-sdk
- Owner: karhoo
- License: bsd-2-clause
- Created: 2020-06-30T10:30:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T08:39:07.000Z (about 2 years ago)
- Last Synced: 2024-05-14T09:47:16.054Z (about 2 years ago)
- Topics: cd-deployment, cicd, ignore-curator, team-mobile
- Language: Swift
- Homepage:
- Size: 8.18 MB
- Stars: 22
- Watchers: 18
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Karhoo iOS UI SDK
The UI SDK extends on our [**Network SDK**](https://github.com/karhoo/karhoo-ios-sdk) with ready to use screens and views for your end users to book rides with [**Karhoo**](https://karhoo.com/) in your application.
For more general information about the SDKs, chechout [**the karhoo developer portal**](https://developer.karhoo.com/docs/build-apps-using-sdks)
## Installation
#### CocoaPods
You can use [CocoaPods](http://cocoapods.org/) to install `KarhooUISDK` by adding it to your `Podfile`:
```ruby
use_frameworks!
pod 'KarhooSDK', :git => 'git@github.com:karhoo/karhoo-ios-sdk', :tag => '1.8.4'
pod 'KarhooUISDK', :git => 'git@github.com:karhoo/karhoo-ios-ui-sdk.git', :tag => '1.13.4'
```
Depending on payment provider you want to use in your integration add:
```ruby
pod 'KarhooUISDK/Braintree', :git => 'git@github.com:karhoo/karhoo-ios-ui-sdk.git', :tag => '1.13.4
```
then import `KarhooUISDK` wherever you want to access Karhoo services
``` swift
import KarhooUISDK
```
#### Swift Package Manager
KarhooUISDK is released as a SPM beginning from version 1.8.0
Use URL for repository: `https://github.com/karhoo/karhoo-ios-ui-sdk`
and you will find 3 available packages:
`KarhooUISDK`: only core package,
`KarhooUISDKAdyen`: core + Adyen payment provider
`KarhooUISDKBraintree`: core + Braintree Payment Provider
then import `KarhooUISDK` wherever you want to access Karhoo services
# Contribution Guide
Install Cocoapods
`brew install cocoapods`
Run
`pod install`
Open KarhooUISDK.xcworkspace
## Running Tests
There is an Xcode scheme for unit tests. Unit tests test the functionality of individual classes using mocked dependencies.
## Client example
There is an example project inside the Client directory of this repository. This is meant to be a fast way to test SDK changes and development steps. You will need to add access Keys to the client module as these are ignored due to this being an open source repository.
```swift
struct Keys {
static let identifier = ""
...
}
```
## Issues
_Looking to contribute?_
### 🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
### 💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.
### ❓ Questions
For questions related to using the library, please re-visit a documentation first. If there are no answer, please create an issue with a label `help needed`.
## License
[BSD-2-Clause](./LICENSE)