https://github.com/surfstudio/debug-screen-ios

https://github.com/surfstudio/debug-screen-ios

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/surfstudio/debug-screen-ios
• Owner: surfstudio
• License: mit
• Created: 2020-10-29T10:36:22.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-24T12:23:42.000Z (about 2 years ago)
• Last Synced: 2025-02-26T15:52:20.109Z (8 months ago)
• Language: Swift
• Homepage: https://surfstudio.github.io/debug-screen-ios/documentation/debugscreen/
• Size: 35.5 MB
• Stars: 4
• Watchers: 14
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DebugScreen

[![Build Status](https://github.com/surfstudio/debug-screen-ios/actions/workflows/main.yml/badge.svg)](https://github.com/surfstudio/debug-screen-ios/actions/workflows/main.yml)

[![SPM Compatible](https://img.shields.io/badge/SPM-compatible-blue.svg)](https://github.com/apple/swift-package-manager)

[![CocoaPods Compatible](https://img.shields.io/badge/CocoaPods-compatible-blue.svg)](https://cocoapods.org)

[![Version](https://img.shields.io/github/release/surfstudio/debug-screen-ios.svg?style=flat)]()

[![DebugScreen](https://i.ibb.co/JBY58v8/Debug-Screen.png)](https://github.com/surfstudio/debug-screen-ios)

## About

Library for quickly creating and customizing an application's debug screen. It allows you to customize your DebugScreen as you want.

![Debug screen demo image](TechDocs/Resources/debug_screen_demo.png)

## Installation

#### Swift Package Manager

- Open your Xcode project and select `File > Add Packages...`

- Enter repository URL `https://github.com/surfstudio/DebugScreen`

#### CocoaPods:

Add following string into your Podfile and run `pod install` command:

```ruby

pod 'DebugScreen'

```

## Features

Library has different components for create debug screen with functionality that you need.

### Available blocks

- **Action** - Allows you to perform some action on button tap

- **ActionsList** - Provides custom actions list, that will be opened on button tap

- **CopiedText** - Allows to add tapable text, that will be copied to clipboard on tap

- **FeatureToggle** - Provides toggles for activate / disable your application features

- **SelectionList** - Allows you to implement element selection from list (using UIPickerView)

Also library has ready-to-use components, can be used for building logger section.

### Services

- **Logger** - Allows you to catch and get all logs from the Xcode console output

- **Presenter** - Provides functionality for open DebugScreen, logs file and show simple alerts with messages 

## Usage

All of this you can see in our Example-project. Download repository and run command `make init` before start. It's needed for project correct setup and work.

Check out the full documentation [here](https://surfstudio.github.io/debug-screen-ios/documentation/debugscreen/).

## Changelog

The full list of changes can be found in this [file](./Changelog.md).

## License

[MIT License](./LICENSE)