Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kouprlabs/voltaserve-swift

🦅 Voltaserve Swift Client
https://github.com/kouprlabs/voltaserve-swift

swift swift-client voltaserve

Last synced: 15 days ago
JSON representation

🦅 Voltaserve Swift Client

Awesome Lists containing this project

README

        

# Voltaserve Swift

## Getting Started

Prerequisites:

- Install [Xcode](https://developer.apple.com/xcode/).
- Install [SwiftLint](https://github.com/realm/SwiftLint).

This is a Swift package, it can be installed using the [Swift Package Manager](https://www.swift.org/documentation/package-manager/) and imported in your code as follows:

```swift
import VoltaserveCore
```

Format code:

```shell
swift format -i -r .
```

Lint code:

```shell
swift format lint -r .
```

```shell
swiftlint lint --strict .
```

## Tests

The test suite expects the following accounts to exist:

| Email | Password |
| ---------------- | ----------- |
| [email protected] | `Passw0rd!` |
| [email protected] | `Passw0rd!` |

Build and run with Docker:

```shell
docker build -t voltaserve/swift-tests . && docker run --rm \
-e API_HOST=host.docker.internal \
-e IDP_HOST=host.docker.internal \
-e USERNAME='[email protected]' \
-e PASSWORD='Passw0rd!' \
-e OTHER_USERNAME='[email protected]' \
-e OTHER_PASSWORD='Passw0rd!' \
voltaserve/swift-tests
```

In Linux you should replace `host.docker.internal` with the host IP address, it can be found as follows:

```shell
ip route | grep default | awk '{print $3}'
```

## Licensing

Voltaserve Swift is released under the [MIT License](LICENSE).