# neutron-webclient

**Repository Path**: mirrors_emersion/neutron-webclient

## Basic Information

- **Project Name**: neutron-webclient
- **Description**: Official AngularJS web client for the ProtonMail secure email service.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: public
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-24
- **Last Updated**: 2026-07-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

ProtonMail Web Client
=======

Official AngularJS web client for the [ProtonMail secure email service](https://protonmail.com). ProtonMail also makes use of [OpenPGPjs](https://github.com/openpgpjs/openpgpjs) as our message crytography is PGP compliant.

### Translations

To assist with the ProtonMail Translation Project, please visit our dedicated translation repository: [translations repository](https://github.com/ProtonMail/translations).

### Basic Installation

#### If you have node >= 0.12 installed locally

- `npm install` (requires nodejs)
- `npm start` to start the app locally at `http://localhost:8080`

#### If you have docker, and prefer to not install node (or anything else) locally

- `make start` to start the app on a container (use `make 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.

### Development

We are very open to bug reports via Issues as well as Pull Requests.

### End to end testing for AngularJS

Installation:

```shell
$ npm install -g protractor
$ webdriver-manager update
```

Start up a Selenium Server:

```shell
$ webdriver-manager start
```

> To run selenium you can use docker if you don't want to install Java :
```sh
$ docker run -d -p 4444:4444 -v /dev/shm:/dev/shm selenium/standalone-chrome:2.53.0
```
cf [Selenium Docker](https://github.com/SeleniumHQ/docker-selenium)


Run tests:
```shell
$ npm run e2e -- --params.password1 "XXX" --params.password2 "XXX"
```
> default account is qatest123, you can change that using `--params.login "xxxx"`


```shell
$ protractor protractor_conf.js
```

Run a scenario:

```shell
$ protractor protractor_conf.js --suite=login
```

### License

Copyright (c) 2013-2016

Proton Technologies A.G. (Switzerland)

Email: contact@protonmail.ch

License: https://github.com/ProtonMail/WebClient/blob/public/license.md