1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-10-30 08:10:34 +01:00
bitwarden-browser/README.md
Oscar Hinton b3f5c72ba9
Bump NPM to v7 (#995)
* Bump NPM to v7

* Refresh package-lock
2021-05-26 22:17:37 +02: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: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=production npm run build:watch

You can also manually adjusting your API endpoint settings by adding config/development.js overriding any of the values in config/base.json. For example:

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

To pick up the overrides in the newly created config/development.js file, run the app with:

npm run build:dev:watch

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.