AppBrowser

AppBrowser is a simple and efficient web browser application for iOS. This README will guide you through the usage of configurator.swift to configure AppBrowser.

Table of Contents

• Installation
• Usage
• Configuration
• Contributing
• Author
• License

Installation

To install AppBrowser, clone the repository and open the project in Xcode:

git clone https://github.com/MaciejGad/AppBrowser.git
cd AppBrowser
open AppBrowser.xcodeproj

Usage

To run the application, select the target device or simulator in Xcode and press the Run button or use the shortcut Cmd + R.

Configuration

To configure AppBrowser, you need to update the config.json file with the following values:

{
    "display_name": "AppBrowser",
    "app_url": "https://github.com/MaciejGad/AppBrowser",
    "bundle_id": "pl.maciejgad.AppBrowser",
    "biometric_authentication": true,
    "icon_name": "f096",
    "icon_background_color": "#3498db",
    "exception_list_url": "https://raw.githubusercontent.com/MaciejGad/AppBrowser/refs/heads/main/AppBrowser/url_exceptions.json",
    "exception_list": [
        "https://maciejgad.pl"
    ],
    "show_path": true,
    "toolbar_items": "goBack,loadHome,reload,openInExternalBrowser,print"
}

Here are the details for each configuration option in the config.json file:

• display_name: The name of the application as it will appear on the home screen and within the app.
• app_url: The URL that will be loaded on start
• bundle_id: The unique identifier for the application, typically in reverse domain name notation.
• biometric_authentication: A boolean value (true or false) indicating whether biometric authentication (such as Face ID or Touch ID) is enabled.
• icon_name: The name of the icon to be used for the application. This should be a valid icon name from Font Awesome.
• icon_background_color: The background color of the application icon, specified in hexadecimal format.
• exception_list_url: The URL to a JSON file containing a list of URL exceptions that the browser should open internally
• exception_list: An internal list of exceptions that the browser should handle differently. This can include URLs that should be opened within the app instead of an external browser.
• show_path: A boolean value (true or false) indicating whether the current URL path should be displayed in the browser's toolbar.
• toolbar_items: A comma-separated list of toolbar items. Available options include:
  • goBack: Navigates to the previous page in the browser history.
  • loadHome: Loads the home page specified in the configuration.
  • reload: Reloads the current page.
  • openInExternalBrowser: Opens the current page in an external browser.
  • print: Prints the current page.

These options allow you to customize the behavior and appearance of AppBrowser to suit your needs.

After updating the config.json file, run the configurator.swift script from the command line to apply the configuration:

./configurator.swift

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

Author

AppBrowser was built by Maciej Gad. Maciej is a software developer with a passion for creating efficient and user-friendly applications. With a background in iOS development, Maciej has worked on various projects ranging from small utilities to large-scale applications. For more information, visit maciejgad.pl or follow him on GitHub and LinkedIn.

License

This project is licensed under the MIT License. See the LICENSE file for details.