FestivalsAPI client library for iOS

Development • Usage • Installation • Engage • Licensing

The framework is designed to make interacting with the Festivals API seamless and efficient. Downloading festivals, artists and other objects to your app is all made easy with FestivalsAPI's components.

Development

TBA

Requirements

• iOS 13.1+
• Xcode 12.4.1+
• swift-tools-version:5.3+
• jazzy 0.13.6+ (for building the documentation)

Usage

TBA

// Create the handler
let client = FestivalsClient(apiKey: <#API Key#>, apiVersion: .v0_1, baseURL: <#API URL#>)

// fetch all festivals
client.festivalHandler.all { (festivals, err) in
    guard let festivals = festivals else {
        print(err)
        return
    }
    
    // use festivals
}

Documentation

The full documentation for the Festivals App is in the festivals-documentation repository. The documentation repository contains technical documents, architecture information, UI/UX specifications, and whitepapers related to this implementation.

Installation

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate FestivalsAPI into your Xcode project using Carthage, specify it in your Cartfilee:

github "https://github.com/Phisto/FestivalsAPI-Swift" ~> 0.1

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding FestivalsAPI as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
.package(url: "https://github.com/Phisto/FestivalsAPI-Swift.git", .upToNextMajor(from: "0.1"))
]

Manually

If you prefer not to use Carthage, you can integrate FestivalsAPI into your project manually. You only need to build and add the FestivalsAPI framework (FestivalsAPI.framework) to your project.

Engage

TBA

The following channels are available for discussions, feedback, and support requests:

Type	Channel
General Discussion
Concept Feedback
Other Requests

Licensing

Copyright (c) 2020 Simon Gaus.

Licensed under the GNU Lesser General Public License v3.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.html.

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.