bitwarden-estensione-browser/README.md

70 lines
2.4 KiB
Markdown
Raw Normal View History

2018-07-26 16:02:04 +02:00
<p align="center">
2018-07-26 16:02:24 +02:00
<img src="https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/web-vault-macbook.png" alt="" width="600" height="358" />
2018-07-26 16:02:04 +02:00
</p>
2018-07-26 15:54:36 +02:00
<p align="center">
2018-07-26 16:02:24 +02:00
The Bitwarden web project is an Angular application that powers the web vault (https://vault.bitwarden.com/).
2018-07-26 15:54:36 +02:00
</p>
<p align="center">
<a href="https://github.com/bitwarden/web/actions?query=branch:master" target="_blank">
<img src="https://github.com/bitwarden/web/actions/workflows/build.yml/badge.svg?branch=master" alt="Github Workflow build on master" />
2018-07-26 15:54:36 +02:00
</a>
<a href="https://crowdin.com/project/bitwarden-web" target="_blank">
<img src="https://d322cqt584bo4o.cloudfront.net/bitwarden-web/localized.svg" alt="Crowdin" />
</a>
<a href="https://hub.docker.com/u/bitwarden/" target="_blank">
<img src="https://img.shields.io/docker/pulls/bitwarden/web.svg" alt="DockerHub" />
</a>
<a href="https://gitter.im/bitwarden/Lobby" target="_blank">
<img src="https://badges.gitter.im/bitwarden/Lobby.svg" alt="gitter chat" />
</a>
</p>
2016-10-14 04:02:46 +02:00
2018-07-26 16:02:04 +02:00
## Build/Run
2018-07-26 16:02:04 +02:00
### Requirements
- [Node.js](https://nodejs.org) v14.17 or greater
- NPM v7
2018-07-26 16:02:04 +02:00
### Run the app
2017-07-14 14:32:30 +02:00
For local development, run the app with:
2018-07-09 22:38:21 +02:00
```
npm install
2021-09-14 13:26:26 +02:00
npm run build:oss:watch
2018-07-09 22:38:21 +02:00
```
You can now access the web vault in your browser at `https://localhost:8080`.
2018-07-09 23:01:15 +02:00
If you want to point the development web vault to the production APIs, you can run using:
```
npm install
2021-09-14 13:26:26 +02:00
ENV=production 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:
```json
{
"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"],
"urls": {
}
}
```
2021-09-14 13:26:26 +02:00
Where the `urls` object is defined by the [Urls type in jslib](https://github.com/bitwarden/jslib/blob/master/common/src/abstractions/environment.service.ts).
2018-07-26 16:02:04 +02:00
## Contribute
2016-10-02 05:32:12 +02:00
2021-04-05 17:07:54 +02:00
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.
2016-10-02 05:32:12 +02:00
2017-05-19 19:27:22 +02:00
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.