1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-05 09:10:53 +01:00
bitwarden-browser/README.md
Matt Gibson 6d4f163824
Update local web development instructions (#1208)
* Indicate production with NODE_ENV

* Use local.json config to point to Bitwarden production APIs

* Add proxy configuration to cloud and qa environment

* Move notifications to urls

Co-authored-by: Hinton <oscar@oscarhinton.com>
2021-10-22 07:50:08 -05:00

2.4 KiB

The Bitwarden web project is an Angular application that powers the web vault (https://vault.bitwarden.com/).

Github Workflow build on master Crowdin DockerHub gitter chat

Build/Run

Requirements

Run the app

For local development, run the app with:

npm install
npm run build:oss:watch

You can now access the web vault in your browser at https://localhost:8080.

If you want to point the development web vault to the production APIs, you can run using:

npm install
ENV=cloud npm run build:oss:watch

You can also manually adjusting your API endpoint settings by adding config/local.json overriding any of the following values:

{
    "dev": {
        "proxyApi": "http://your-api-url",
        "proxyIdentity": "http://your-identity-url",
        "proxyEvents": "http://your-events-url",
        "proxyNotifications": "http://your-notifications-url",
        "allowedHosts": ["hostnames-to-allow-in-webpack"],
    },
    "urls": {
      
    }
}

Where the urls object is defined by the Urls type in jslib.

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 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 file.