Upstream
/
bitwarden-desktop
mirror of https://github.com/bitwarden/desktop.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
bitwarden-desktop/README.md

34 lines
1.7 KiB
Markdown
Raw Normal View History

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-05-19 23:56:37 +02:00
[![Platforms](https://imgur.com/SLv9paA.png "Windows, macOS, and Linux")](https://bitwarden.com/#download)
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
Fetch image from bitwarden/brand (#109)
2018-07-19 16:50:20 +02:00
![Desktop Vault](https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/desktop-macos-vault.png "My Vault")
Update README.md
2018-02-19 23:57:51 +01:00
# Build/Run
**Requirements**
Update README.md
2018-02-20 17:37:27 +01:00
- [Node.js](https://nodejs.org/)
Biometric support (#470) * Initial work on windows hello support * Hide login button if not enabled * Add windows.security.credentials.ui dependency to desktop as well. * Only enable biometric on windows. * Add support for dynamic biometric text. * Add untested darwin implementation * Ensure we support biometric before showing login with windows hello / touchid. * Ensure compatability with latest jslib * Only require module on use. * Add windows.security.credentials.ui to src/package.json. * Update requirements * Update consent messages for biometrics
2020-07-23 19:32:36 +02: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. You will also need to install the *Microsoft Build Tools 2015* and *Windows 10 SDK 17134* as additional dependencies in the Visual Studio installer.
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.