Proton VPN para iOS y macOS

Dependencias

Este proyecto utiliza Swift Package Manager para todas sus dependencias. Permite que Xcode resuelva los paquetes antes de ejecutar cualquier target.

Dependencias de terceros

ACKNOWLEDGEMENTS.md

Configuración

Habilita Git LFS en tu máquina
Clona este repositorio
Asegúrate de clonar los submódulos (git submodule init + git submodule update)
Instala las dependencias de Homebrew con brew bundle
Por ahora necesitarás usar Xcode 14.x
Configura el firmado de código para todos los targets con una cuenta de desarrollador de Apple de pago (requerido por los entitlements de VPN) y cambia los bundle identifiers a algo único
Limpia la carpeta de compilación en Xcode (Cmd+Shift+K)

Constantes ofuscadas

Se requiere un conjunto de secretos para poder compilar el proyecto. Estos incluyen URLs y claves, y se mantienen en archivos llamados ObfuscatedConstants.swift. Estos archivos se guardan en un repositorio separado, lo que requiere una configuración adicional para mantenerlos sincronizados.

Primero, invoca el script ubicado en Integration/Scripts/credentials.sh con el comando setup. Proporciona la ruta donde deseas que se clone localmente el repositorio de secretos usando el argumento -p, y la URL del repositorio usando el argumento -r.

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

Luego, para verificar que la configuración se ha realizado correctamente:

./Integration/Scripts/credentials.sh checkout

Si la configuración es correcta, las constantes ofuscadas se sincronizarán automáticamente durante la fase de compilación Generate Obfuscated Constants de cada aplicación.

Estructura del paquete

El proyecto está empaquetado por capas para evitar el infierno de dependencias de módulos:

Foundations: librerías pequeñas y de un solo propósito para construir cosas más grandes. Estas solo deberían enlazarse entre sí, si es que lo hacen.
Shared: librerías ligeramente más grandes destinadas a compartir código entre aplicaciones o extensiones. Las porciones de esta librería que crezcan demasiado o que se beneficien de ser su propio módulo pueden separarse en Foundations. Estas solo deberían enlazar librerías de Foundations, con la posible excepción de que cada una de estas librerías enlace CoreCommon.
Features: librerías autocontenidas que contienen una única funcionalidad. Estas librerías solo deberían enlazar librerías de las categorías Shared o Foundations. Se incluyen e instancian dentro del código de aplicación, pruebas o extensiones.

Se debe evitar añadir código o funcionalidades nuevos a LegacyCommon y NEHelper siempre que sea posible. Estos paquetes deben reducirse gradualmente para colocar sus componentes en paquetes nuevos o existentes de las tres categorías anteriores.

Linting de código

Durante el desarrollo, swiftlint se ejecuta en modo no estricto para que sea más fácil desarrollar sin preocuparse por el formato del código. En CI, el linting es estricto y fallará ante cualquier aviso. Antes de commitear código a este repositorio, ejecuta el siguiente script para añadir un hook de pre-commit que comprobará todos los archivos nuevos/modificados en modo estricto y te impedirá commitear código que no pasaría el CI.

./Integration/Scripts/pre_commit_lint.sh setup

Localización

La aplicación usa SwiftGen para generar el archivo Localizable.strings con el fin de acceder a todas las cadenas de la aplicación almacenadas en los archivos estándar Localizable.strings. Solo añade una nueva cadena al paquete Strings y ejecuta el comando swiftgen en un directorio donde esté definido swiftgen.yml.

Licencia

Los archivos de código y datos de esta distribución están licenciados bajo los términos de la GPLv3 publicada por la Free Software Foundation. Consulta https://www.gnu.org/licenses/ para obtener una copia de esta licencia.

ios-mac-app

Más Populares