Update README.md

This commit is contained in:
Kyle Spearrin 2018-02-20 11:36:27 -05:00 committed by GitHub
parent 974224cee7
commit aecbbc5fb1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 7 deletions

View File

@ -16,16 +16,13 @@ The Bitwarden desktop app is written using Electron and Angular. The application
**Requirements** **Requirements**
- [Node.js](https://nodejs.org/en/) - [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`). 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: **Run the app**
```git
git submodule update --init --recursive
```
Then run the following commands:
```bash ```bash
npm install npm install