mirror of
https://github.com/bitwarden/browser
synced 2024-12-29 11:22:30 +01:00
40 lines
1.9 KiB
Markdown
40 lines
1.9 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
|
|
|
|
<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.
|
|
|
|
|
|
|
|
# Build/Run
|
|
|
|
**Requirements**
|
|
|
|
- [Node.js](https://nodejs.org/en/)
|
|
|
|
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`).
|
|
|
|
You should also make sure that you have pulled the latest for the [`jslib`](https://github.com/bitwarden/jslib) submodule by running:
|
|
|
|
```git
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
Then run the following commands:
|
|
|
|
```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.
|