Need help with firefox-ios?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

mozilla-mobile
10.5K Stars 2.4K Forks Mozilla Public License 2.0 8.9K Commits 1.1K Opened issues

Description

Firefox for iOS

Services available

!
?

Need anything else?

Contributors list

Firefox for iOS codebeat badge BuddyBuild codecov

Download on the App Store.

This branch (main)

This branch works with Xcode 12.5.1, Swift 5.4.2 and supports iOS 11.4 and above.

Please note: due to dependency issues, development of Firefox-iOS is currently only supported on Intel based Macs, and not Apple Silicon based Macs.

Please make sure you aim your pull requests in the right direction.

For bug fixes and features for a specific release, use the version branch.

Getting involved

Want to contribute but don't know where to start? Here is a list of issues that are contributor friendly

Building the code

  1. Install the latest Xcode developer tools from Apple.
  2. Install Carthage, Node, and a Python 3 virtualenv for localization scripts:
    shell
    brew update
    brew install carthage
    brew install node
    pip3 install virtualenv
    
  3. Clone the repository:
    shell
    git clone https://github.com/mozilla-mobile/firefox-ios
    
  4. Pull in the project dependencies:
    shell
    cd firefox-ios
    sh ./bootstrap.sh
    
  5. Open
    Client.xcodeproj
    in Xcode.
  6. Build the
    Fennec
    scheme in Xcode.

Building User Scripts

User Scripts (JavaScript injected into the

WKWebView
) are compiled, concatenated, and minified using webpack. User Scripts to be aggregated are placed in the following directories:
/Client
|-- /Frontend
    |-- /UserContent
        |-- /UserScripts
            |-- /AllFrames
            |   |-- /AtDocumentEnd
            |   |-- /AtDocumentStart
            |-- /MainFrame
                |-- /AtDocumentEnd
                |-- /AtDocumentStart

This reduces the total possible number of User Scripts down to four. The compiled output from concatenating and minifying the User Scripts placed in these folders resides in

/Client/Assets
and are named accordingly:
  • AllFramesAtDocumentEnd.js
  • AllFramesAtDocumentStart.js
  • MainFrameAtDocumentEnd.js
  • MainFrameAtDocumentStart.js

To simplify the build process, these compiled files are checked-in to this repository. When adding or editing User Scripts, these files can be re-compiled with

webpack
manually. This requires Node.js to be installed, and all required
npm
packages can be installed by running
npm install
in the project's root directory. User Scripts can be compiled by running the following
npm
command in the root directory of the project:
npm run build

Contributing

Want to contribute to this repository? Check out Contributing Guidelines

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at https://mozilla.org/MPL/2.0/

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.