No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 51ec28f Nov 13, 2018
Permalink
Failed to load latest commit information.
SwiftElasticSearch Removed unnecessary files Nov 12, 2018
README.md Added easiest way to install the library Nov 12, 2018

README.md

SwiftElasticSearch

About Project

This project aims to create fast responsive Swift Library, supported for IPhone and Mac apps which provides the functionality of Elastic Search to be integrated in the app.

The library provides very high performance results i.e. it provides response to user queries in milliseconds of time including the elastic search processing time.

Installation

Cloning project (Easiest way)

  • Download the project using command :
git clone "https://github.com/appbaseio-apps/SwiftElasticSearch.git"
  • Navigate to file SwiftElasticSearch.xcodeproj and copy and paste it in your project directory (Under blue file icon in Xcode)

  • Navigate to General Settings (click on blue file icon) -> Linked Framweworks and binaries

  • Click on + icon and add the SwiftElasticSearch.framework file that is available under Workspace folder

  • Build the project and that's it. The library is ready to import

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but ElasticSwift does support its use on supported platforms.

To add SwiftElasticSearch library as dependency, add the following line in the dependencies value of Package.swift :

dependencies: [
.Package(url: "https://github.com/appbaseio-apps/SwiftElasticSearch.git", "1.1.0")
]

Manual Installation

  • Download the project using command :
git clone "https://github.com/appbaseio-apps/SwiftElasticSearch.git"
  • Build the project in the Xcode software in its release mode (Product -> Scheme -> Edit Scheme -> Release Mode) and copy the .framework file that is generated and paste it on the Desktop

  • Open the project in which the library needs to be used

  • Open Build Phases tab in the Build Settings of the project and add the copied framework in Link Binary with Libraries section

  • Now the library is ready to use in your project

If the library doesn't work (or isn't imported):

  • Open File -> New File -> Header File

  • Name the header file as -Bridging-Header

  • Go to Project -> Build Settings and browse to Bridging option

  • Double click on the Objective-C Bridging Header and enter -Bridging-Header in the pop-up dialog box

  • Import the library in the new bridging header file and now the library is ready to use

Docs

WIP docs are at https://swift-elasticsearch.netlify.com.