Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 3.19 KB

README.md

File metadata and controls

74 lines (56 loc) · 3.19 KB
Raw

Firefox for iOS codebeat badge BuddyBuild codecov

Download on the App Store.

This branch (main)

This branch only works with Xcode 11.5, Swift 5.2 and supports iOS 12.0 and above.

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 and Node 
    brew update
brew install carthage
brew install node
  3. Clone the repository: 
    git clone https://github.com/mozilla-mobile/firefox-ios
  4. Pull in the project dependencies: 
    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 root directory of the project. 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