Official AngularJS web client for the ProtonMail secure email service. ProtonMail also makes use of OpenPGPjs as our message cryptography is PGP compliant.
We are currently working with our community to localize ProtonMail from English to most of the world's major languages. If you're interested in being part of this translation project, send us an email to [email protected] with the subject line "ProtonMail Translation Project [Your Language]" and we will offer you more information about it.
npm install
npm start
To run the app without babel
npm run start:raw
- Node.js >= v8
- npm 6
- git
You need to install a few dep in order to be able to deploy
brew install libpng
or
brew upgrade libpng
if you already have the lib
If you use Windows, you will need to have bash on your computer in order to execute everything ex:
- run tests
- deploy
- etc.
- Install bash then check the path of bash ex:
C:\\Program Files\\git\\bin\\bash.exe"
npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
- 🍿
make start
to start the app on a container (usemake localurl
to find the url where it's running)make test
to build the app (actual tests are still to come)
There is a very good chance you won't be able to use the app locally because of various security headers and such. But you should be able to get the code running enough to poke around and inspect it.
We are still in Beta and will have a more refined build process, installation instructions, unit tests, and all that good stuff once we exit Beta.
We are very open to bug reports via Issues as well as Pull Requests.
npm run build
Same as
npm start
use --api to change the default api
npm run build:ci
Same as
npm start
use --api to change the default api
npx appComponent
npm run create
npm run create:test
- Create a new version + tag =>
npm version (patch|minor|major)
. - Deploy via npm
npm run deploy -- --api=X --branch=Y
.X
is the API version available inAPI_TARGETS
in theenv/config.js
fileY
can bedeploy-dev
,deploy-beta
,deploy-prod-a
ordeploy-prod-b
.
Each deploy-<NAME>
will be available at <NAME>.protonmail.com
.
npm run deployProd
will deploy the bundle for both prod, old, dev and tor
--branch
: Deploy branch dest--api
: Set an API for the app (dev, live, etc.)--debug
: turn on debug mode for the command (default false)
Extract translation keys
npm run i18n:extract
We build i18n when we create a build for beta or prod
npm run i18n:build
It will do everything you need. Import new translations first for a better result ;)
NOTE: In order to generate the release notes you need to set the RELEASER_GH_TOKEN
environment variable.
To generate release notes for the latest version (tag), run the following command:
npm run releaser:extract
To generate release notes for a specific version (tag), run:
npm run releaser:extract -- --tag v3.12.24
The release notes are outputted to stdout
. Those notes have to be manually inserted to CHANGELOG.md
.
It is also possible to run the following command to automatically unshift the output from releaser into CHANGELOG.md
npm run releaser:unshift
The HTML file from the CHANGELOG.md
file is automatically generated when running start -- --debug
or dist
. It takes the markdown file and generates the HTML file at ${build}/assets/changelog.tpl.html
which will be dynamically fetched when the modal opens.
For a fix linked to an issue number:
(Fix|Close|Resolve) #ISSUENUMBER
(multiple allowed, separated by comma)
For a hotfix not linked to any issue:
Hotfix - Description
Any commits that follow this convention will be included in the release notes generator.
For fixes linked to an issue, the description will be taken from GitHub and grouped according to if it has the Bug
or Feature
label.
For hotfixes, the description in the commit name will be included in the release notes under the group Others
.
For a fix
fix/<your feature>
For a feature
feat/<your feature>
- or
feature/<your feature>
npm test
To edit test it's better to run
npm run testwatch
(tests with a watcher)
Based on The Amazing Cypress.
Dev:
npx cypress open
or npm run cypress:open
CI:
npm run e2e
Copyright (c) 2013-2019
Proton Technologies A.G. (Switzerland)
Email: [email protected]
License: https://github.com/ProtonMail/WebClient/blob/public/LICENSE