What it is

Proton WebClients is a monorepo hosting the Proton web clients. It lives in the Proton ecosystem and holds the web applications, their dependencies, shared modules, and all tooling surrounding web client development. Applications inside include Proton Mail, Proton Calendar, Proton Drive, Proton Account, Proton VPN, Proton Pass, Proton Wallet, Proton Lumo, and Proton Meet. Code and data files ship under GNU General Public License version 3.

Problem it solves: each client previously needed its own dependency tree and build setup, which fragments shared modules. Monorepo based on Yarn and Yarn Workspaces, with unified versioning for all packages inside. Shared code sits in @proton/components and @proton/shared. Workspaces symlink local dependents to one another, so one common install wires every client.

Key capabilities

• Hosts multiple web clients in one tree: Mail, Calendar, Drive, Account, VPN, Pass, Wallet, Lumo, Meet.
• Uses Yarn Workspaces, with local dependents symlinked to one another after a single yarn install.
• Applies unified versioning across all packages in the monorepo.
• Shares modules through @proton/components and @proton/shared.
• Serves VPN from two separate entry points: applications/vpn-settings for protonvpn.com and applications/account for account.proton.me/u/{X}/vpn.
• Provides start-all with an --applications flag to launch a chosen set of clients together.
• Includes manual application versioning through yarn workspace @proton/version run version --applications proton-X --version x.x.x.x.
• Covered by topics including monorepo, pgp, react, webmail, and yarn.

Who uses it and how

• Developers run a single client from root, for example yarn workspace proton-mail start.
• Teams serve VPN through vpn-settings on port 8050 with yarn workspace --port 8050 proton-vpn-settings start.
• Teams serve VPN through the account application with yarn start-all --applications "proton-account", needed because both domains are separate and local SSO is not shared between them.
• Maintainers cut releases on the main branch from the root folder using the version workspace command.
• Translation contributors follow the project translation community process described in the linked blog post.

Getting started

Prerequisites are Node.js LTS, Yarn 4, and git; package.json holds specific version requirements. Clone https://github.com/ProtonMail/WebClients.git, run yarn install to install all dependencies for the entire monorepo and symlink local dependents, then start any client with yarn workspace proton- start.

When to use it — and when not to

README lists no Docker image, no published package, and no hosted option, so use means cloning and building from source with Node.js LTS and Yarn 4 on hand. Versioning is manual per application, and VPN is split across two entry points that do not share local SSO, which complicates local serving. The listing shows 155 open issues, 5585 stars, 711 forks, and 0 contributors recorded, so review the issue tracker before committing to it.

# Clone the project
git clone https://github.com/ProtonMail/WebClients.git
git clone [email protected]:ProtonMail/WebClients.git

# Install all dependencies for the entire monorepo & symlink
# local dependents to one another
yarn install

# Run web clients by running proton-<package-name>
# Example: proton mail web client
yarn workspace proton-mail start

# To serve VPN through vpn-settings
yarn workspace --port 8050 proton-vpn-settings start

# To serve VPN through account
yarn start-all --applications "proton-account"