Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/protonmail/webclients
Monorepo hosting the proton web clients
https://github.com/protonmail/webclients
monorepo pgp protoncalendar protoncontacts protondrive protonmail react webmail yarn
Last synced: about 1 month ago
JSON representation
Monorepo hosting the proton web clients
- Host: GitHub
- URL: https://github.com/protonmail/webclients
- Owner: ProtonMail
- License: gpl-3.0
- Created: 2016-06-08T11:16:51.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T16:04:51.000Z (7 months ago)
- Last Synced: 2024-04-13T22:26:20.475Z (7 months ago)
- Topics: monorepo, pgp, protoncalendar, protoncontacts, protondrive, protonmail, react, webmail, yarn
- Language: TypeScript
- Homepage:
- Size: 923 MB
- Stars: 4,085
- Watchers: 149
- Forks: 520
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Web clients
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).
- 
Proton Mail
- 
Proton Calendar
- 
Proton Drive
- 
Proton Account
- 
Proton VPN
- 
Proton Pass
- 
Proton Wallet
Technically, this monorepo is based on Yarn 3 & Yarn Workspaces, with unified versioning for all packages inside.
## Getting Started
You'll need to have the following environment to work with this project
- Node.js LTS
- Yarn 3
- git
You can find more detailed version-constrains for Node.js and yarn in `package.json`.
```shell
# 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-
# Example: proton mail web client
yarn workspace proton-mail start
```
For additional details on how to interact with the monorepo, see the [yarn docs](https://yarnpkg.com/) for reference.
## Help us to translate the project
You can learn more about it on [our blog post](https://proton.me/blog/translation-community).
## License
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](LICENSE) file