Skip to content

recruit-lifestyle/FeedbackMan

Repository files navigation

FeedbackMan

Version License Platform Carthage compatible

A feedback tool for iOS developers, which can send a lot of information with simple operation.

Requirements

  • iOS 9.0+
  • Xcode 8.3.3

GIF Animation

Screen Capture

capture

Edit Image

edit

Send Feedback

send

Installation

CocoaPods

FeedbackMan is available through CocoaPods.
If you have not installed CocoaPods, run the following command:

$ gem install cocoapods

then, add the following line to your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!

pod 'FeedbackMan'

To import FeedbackMan into your project, run the following command:

$ pod install

Carthage

Carthage is a simple, decentralized dependency manager for Cocoa.
To install FeedbackMan through Carthage, simply add the following line to your Cartfile:

github "recruit-lifestyle/FeedbackMan"

then, run the following command:

$ carthage update --platform iOS

Usage

Requirements

Please get your Slack API token.
You can create token at the following page: https://api.slack.com/custom-integrations/legacy-tokens

To activate FeedbackMan, add the following line to AppDelegate.swift in your project:

import FeedbackMan

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    FeedbackManManager.APIConstants.token = "xoxp-xxxxxxxxxx-xxxxxxxxxx"     // Your Slack API token.
    FeedbackManManager.APIConstants.channel = "feedback-channel"      // Your Slack channel to which you want to send feedback data.
    window?.makeKeyAndVisible()
    FeedbackManManager.sharedInstance.showDebugBtn()
    return true
}

That's all. You can use this library and post your feedback immediately!

Enable Debug mode

If you want to activate FeedbackMan only in Debug build, write in AppDelegate.swift as follows:

import FeedbackMan

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    FeedbackManManager.APIConstants.token = "xoxp-xxxxxxxxxx-xxxxxxxxxx"
    FeedbackManManager.APIConstants.channel = "feedback-channel"
    window?.makeKeyAndVisible()
    #if DEBUG
        FeedbackManManager.sharedInstance.showDebugBtn()
    #endif
    return true
}

then, set the property Swift Compiler - Custom Flags at Build Settings as following image:

custom_flags

Customize

You can launch FeedbackMan in any kind of way as you like. (other button, widget, shake, etc.)
To launch this library, please call the following method in your app:

FeedbackManManager.sharedInstance.showModal()

Credits

FeedbackMan is owned and maintained by RECRUIT LIFESTYLE CO., LTD.

FeedbackMan was originally created by Naomichi Okada and Masafumi Hayashi.

License

Copyright 2017 RECRUIT LIFESTYLE CO., LTD.

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.