This project is a monorepo hosting the proton web clients. It includes the web applications, their dependencies & shared modules as well as all tooling surrounding development of the web clients (as well as some additional miscellaneous things).
Technically, this monorepo is based on Yarn 2 & Yarn Workspaces, with unified versioning for all packages inside.
You'll need to have the following environment to work with this project
- Node.js LTS
- Yarn 2
- git
# 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
For additional details on how to interact with the monorepo, see the yarn docs for reference.
You can help us to translate the application on crowdin.
- For proton-mail, proton-drive, proton-account: Crowdin ProtonMail
- For proton-calendar: Crowdin ProtonCalendar
- For proton-vpnsettings: Crowdin ProtonVPN
The code and data files in this distribution are licensed under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See https://www.gnu.org/licenses/ for a copy of this license.
See LICENSE file