README.md

   1 # Web clients
   2
   3 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).
   4
   5 -   <img src="./applications/mail/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton Mail</span>
   6 -   <img src="./applications/calendar/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton Calendar</span>
   7 -   <img src="./applications/drive/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton Drive</span>
   8 -   <img src="./applications/account/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton Account</span>
   9 -   <img src="./applications/vpn-settings/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton VPN</span>
  10 -   <img src="./applications/pass/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton Pass</span>
  11 -   <img src="./applications/wallet/src/favicon.svg" style="vertical-align: middle" height="20" width="20" /> <span style="vertical-align: middle; display: inline-block">Proton Wallet</span>
  12
  13 Technically, this monorepo is based on Yarn 3 & Yarn Workspaces, with unified versioning for all packages inside.
  14
  15 ## Getting Started
  16
  17 You'll need to have the following environment to work with this project
  18
  19 -   Node.js LTS
  20 -   Yarn 3
  21 -   git
  22
  23 You can find more detailed version-constrains for Node.js and yarn in `package.json`.
  24
  25 ```shell
  26 # Clone the project
  27 git clone https://github.com/ProtonMail/WebClients.git
  28 git clone git@github.com:ProtonMail/WebClients.git
  29
  30 # Install all dependencies for the entire monorepo & symlink
  31 # local dependents to one another
  32 yarn install
  33
  34 # Run web clients by running proton-<package-name>
  35 # Example: proton mail web client
  36 yarn workspace proton-mail start
  37 ```
  38
  39 For additional details on how to interact with the monorepo, see the [yarn docs](https://yarnpkg.com/) for reference.
  40
  41 ## Help us to translate the project
  42
  43 You can learn more about it on [our blog post](https://proton.me/blog/translation-community).
  44
  45 ## License
  46
  47 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.
  48
  49 See [LICENSE](LICENSE) file