Proton VPN für iOS und macOS

Abhängigkeiten

Dieses Projekt verwendet Swift Package Manager für alle seine Abhängigkeiten. Erlaube Xcode, Pakete aufzulösen, bevor du ein Ziel ausführst.

Abhängigkeiten von Drittanbietern

ACKNOWLEDGEMENTS.md

Einrichtung

Aktiviere Git LFS auf deinem Rechner
Klone dieses Repository
Stelle sicher, dass du die Submodule klonst (git submodule init + git submodule update)
Installiere die Homebrew-Abhängigkeiten mit brew bundle
Du musst vorerst Xcode 14.x verwenden
Konfiguriere die Codesignierung für alle Ziele mit einem kostenpflichtigen Apple-Entwicklerkonto (aufgrund der VPN-Berechtigungen erforderlich) und ändere die Bundle-Identifikatoren in etwas Einzigartiges
Bereinige den Build-Ordner in Xcode (Cmd+Shift+K)

Verschleierte Konstanten

Zum Erstellen des Projekts ist eine Reihe von Geheimnissen erforderlich. Diese umfassen URLs und Schlüssel und werden in Dateien mit dem Namen ObfuscatedConstants.swift aufbewahrt. Diese Dateien werden in einem separaten Repository aufbewahrt, was eine zusätzliche Einrichtung erfordert, um sie synchron zu halten.

Rufe zunächst das Skript unter Integration/Scripts/credentials.sh mit dem Befehl setup auf. Gib den Pfad an, in dem du das Geheimnisse-Repository lokal klonen möchtest, mit dem Argument -p, und die URL des Repositorys mit dem Argument -r.

./Integration/Scripts/credentials.sh setup -p <path to credentials repo> -r <credentials remote>

Um dann zu überprüfen, ob die Einrichtung erfolgreich war:

./Integration/Scripts/credentials.sh checkout

Wenn die Einrichtung korrekt durchgeführt wurde, werden die verschleierten Konstanten automatisch während der Build-Phase „Generate Obfuscated Constants“ jeder App synchronisiert.

Paketstruktur

Das Projekt ist nach Schichten verpackt, um die Modulabhängigkeits-Hölle zu vermeiden:

Foundations: kleine Bibliotheken mit einem einzigen Zweck, um größere Dinge zu bauen. Diese sollten untereinander, wenn überhaupt, nur aufeinander verlinken.
Shared: etwas größere Bibliotheken, die dazu dienen, Code zwischen Anwendungen oder Erweiterungen zu teilen. Teile dieser Bibliothek, die zu groß werden oder davon profitieren würden, ein eigenes Modul zu sein, können in Foundations aufgeteilt werden. Diese sollten nur Foundations-Bibliotheken verlinken, mit der möglichen Ausnahme, dass jede dieser Bibliotheken CoreCommon verlinkt.
Features: eigenständige Bibliotheken, die eine einzelne Funktion enthalten. Diese Bibliotheken sollten nur Bibliotheken aus den Kategorien Shared oder Foundations verlinken. Sie werden in Anwendungs-, Test- oder Erweiterungscode eingebunden und instanziiert.

Das Hinzufügen von neuem Code/neuen Funktionen zu LegacyCommon und NEHelper sollte nach Möglichkeit vermieden werden. Diese Pakete sollten nach und nach abgebaut werden, um ihre Komponenten in neue/bestehende Pakete in den obigen drei Kategorien zu verschieben.

Code-Linting

Während der Entwicklung wird swiftlint im nicht-strengen Modus ausgeführt, sodass die Entwicklung einfacher ist, ohne sich um die Codeformatierung zu kümmern. Bei CI ist das Linting streng und schlägt bei jeder Warnung fehl. Bevor du Code in dieses Repository committest, führe das folgende Skript aus, um einen Pre-Commit-Hook hinzuzufügen, der alle neuen/geänderten Dateien im strengen Modus prüft und dich davon abhält, Code zu committen, der CI nicht bestehen würde.

./Integration/Scripts/pre_commit_lint.sh setup

Lokalisierung

Die App verwendet SwiftGen, um die Datei Localizable.strings zu generieren, um auf alle App-Strings zuzugreifen, die in den standardmäßigen Localizable.strings-Dateien gespeichert sind. Füge einfach einen neuen String zum Strings-Paket hinzu und führe den Befehl swiftgen in einem Verzeichnis aus, in dem swiftgen.yml definiert ist.

Lizenz

Die Code- und Datendateien in dieser Distribution sind unter den Bedingungen der GPLv3 lizenziert, wie sie von der Free Software Foundation veröffentlicht wurde. Siehe https://www.gnu.org/licenses/ für eine Kopie dieser Lizenz.

ios-mac-app

Beliebteste