Upstream/bitwarden-browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser.git synced 2024-12-01 13:13:36 +01:00
Code Issues Projects Releases Wiki Activity

Update readme with rust instructions (#1482)

Browse Source
This commit is contained in:
Oscar Hinton 2022-04-12 08:24:09 +02:00 committed by GitHub
parent 2e3c89269d
commit 70db11e659
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -12,7 +12,7 @@ The Bitwarden desktop app is written using Electron and Angular. The application
# Build/Run # Build/Run
**Requirements** ## Requirements
- [Node.js](https://nodejs.org) v16.13.1 (LTS) or greater - [Node.js](https://nodejs.org) v16.13.1 (LTS) or greater
- NPM v8 - NPM v8
@ -22,14 +22,24 @@ The Bitwarden desktop app is written using Electron and Angular. The application
- Linux: - Linux:
- The following packages `build-essential libsecret-1-dev libglib2.0-dev` - The following packages `build-essential libsecret-1-dev libglib2.0-dev`
**Run the app** ## Build native module
The desktop application relies on native code written in rust, which needs to be compiled first.
```bash ```bash
npm install cd desktop_native
npm ci
npm run build
```
## Run the app
```bash
npm ci
npm run electron npm run electron
``` ```
**Debug Native Messaging** ### Debug Native Messaging
Native Messaging (communication with the browser extension) works by having the browser start a lightweight proxy application baked into our desktop binary. To setup an environment which allows Native Messaging (communication with the browser extension) works by having the browser start a lightweight proxy application baked into our desktop binary. To setup an environment which allows
for easy debugging you will need to build the application for distribution, i.e. `npm run dist:<platform>`, start the dist version and enable desktop integration. This will write some manifests for easy debugging you will need to build the application for distribution, i.e. `npm run dist:<platform>`, start the dist version and enable desktop integration. This will write some manifests