bitwarden-desktop/README.md

[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/desktop?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/desktop)
[![travis build](https://travis-ci.org/bitwarden/desktop.svg?branch=master)](https://travis-ci.org/bitwarden/desktop)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-desktop/localized.svg)](https://crowdin.com/project/bitwarden-desktop)
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)

# Bitwarden Desktop Application

<img src="https://imgur.com/491cc2K.png" width="345" height="100">

The Bitwarden desktop app is written using Electron and Angular. The application installs on Windows, macOS, and Linux distributions.

![My Vault](http://imgur.com/fdhNCJl.png "My Vault")

# Build/Run

**Requirements**

- [Node.js](https://nodejs.org/en/)
- Windows users: To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer (recommended) or by installing [`windows-build-tools`](https://github.com/felixrieseberg/windows-build-tools) through `npm`. See more at [Compiling native Addon modules](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules).

**API endpoint**

By default the extension is targeting the production API. If you are running the [Core](https://github.com/bitwarden/core) API locally, you'll need to switch the extension to target your local instance. Open `jslib/src/services/api.service.ts` and set `this.baseUrl` and `this.identityBaseUrl` to your local API instance (ex. `http://localhost:5000`).

**Run the app**

```bash
npm install
npm run electron
```

# Contribute

Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the [`SECURITY.md`](SECURITY.md) file.
Update README.md 2018-02-19 23:57:51 +01:00			`[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/desktop?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/desktop)`
			`[![travis build](https://travis-ci.org/bitwarden/desktop.svg?branch=master)](https://travis-ci.org/bitwarden/desktop)`
Update README.md 2018-02-20 03:01:43 +01:00			`[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-desktop/localized.svg)](https://crowdin.com/project/bitwarden-desktop)`
Update README.md 2018-02-19 23:57:51 +01:00			`[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)`

			`# Bitwarden Desktop Application`

Update README.md 2018-02-20 02:56:13 +01:00			`<img src="https://imgur.com/491cc2K.png" width="345" height="100">`
Update README.md 2018-02-19 23:57:51 +01:00
Update README.md 2018-02-20 02:56:13 +01:00			`The Bitwarden desktop app is written using Electron and Angular. The application installs on Windows, macOS, and Linux distributions.`
Update README.md 2018-02-19 23:57:51 +01:00
			`![My Vault](http://imgur.com/fdhNCJl.png "My Vault")`

			`# Build/Run`

			`Requirements`

			`- [Node.js](https://nodejs.org/en/)`
Update README.md 2018-02-20 17:36:27 +01:00			- Windows users: To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer (recommended) or by installing [`windows-build-tools`](https://github.com/felixrieseberg/windows-build-tools) through `npm`. See more at [Compiling native Addon modules](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules).
Update README.md 2018-02-19 23:57:51 +01:00
Update README.md 2018-02-20 17:36:27 +01:00			`API endpoint`
Update README.md 2018-02-19 23:57:51 +01:00
Update README.md 2018-02-20 17:36:27 +01:00			By default the extension is targeting the production API. If you are running the [Core](https://github.com/bitwarden/core) API locally, you'll need to switch the extension to target your local instance. Open `jslib/src/services/api.service.ts` and set `this.baseUrl` and `this.identityBaseUrl` to your local API instance (ex. `http://localhost:5000`).
Update README.md 2018-02-19 23:57:51 +01:00
Update README.md 2018-02-20 17:36:27 +01:00			`Run the app`
Update README.md 2018-02-19 23:57:51 +01:00
			```bash
			`npm install`
			`npm run electron`
			```

			`# Contribute`

			Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.

			Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the [`SECURITY.md`](SECURITY.md) file.