37 lines
2.2 KiB
Markdown
37 lines
2.2 KiB
Markdown
[](https://ci.appveyor.com/project/bitwarden/desktop)
|
|
[](https://travis-ci.org/bitwarden/desktop)
|
|
[](https://crowdin.com/project/bitwarden-desktop)
|
|
[](https://gitter.im/bitwarden/Lobby)
|
|
|
|
# Bitwarden Desktop Application
|
|
|
|
<a href="https://bitwarden.com/#download"><img src="https://imgur.com/SLv9paA.png" width="500" height="113"></a>
|
|
|
|
The Bitwarden desktop app is written using Electron and Angular. The application installs on Windows, macOS, and Linux distributions.
|
|
|
|
|
|
|
|
# Build/Run
|
|
|
|
**Requirements**
|
|
|
|
- [Node.js](https://nodejs.org/)
|
|
- 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.
|