1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-27 12:36:14 +01:00
bitwarden-browser/README.md

43 lines
1.5 KiB
Markdown
Raw Normal View History

2017-12-05 17:12:34 +01:00
[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/web?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/web) [![DockerHub](https://img.shields.io/docker/pulls/bitwarden/web.svg)](https://hub.docker.com/u/bitwarden/) [![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
2016-10-14 04:02:46 +02:00
2018-02-28 04:41:27 +01:00
# Bitwarden Web Vault
2016-10-02 05:32:12 +02:00
2018-07-09 22:38:21 +02:00
The Bitwarden web project is an Angular application that powers the web vault (https://vault.bitwarden.com/).
2016-10-02 05:32:12 +02:00
2018-05-12 19:56:19 +02:00
<img src="https://i.imgur.com/WB8J2bt.png" alt="" />
2017-05-19 19:27:22 +02:00
# Build/Run
**Requirements**
2018-07-09 22:38:21 +02:00
- [Node.js](https://nodejs.org) v8.11 or greater
2018-07-09 22:38:21 +02:00
**Run the app**
2017-07-14 14:32:30 +02:00
2018-07-09 22:38:21 +02:00
```
npm install
npm run build:watch
```
2018-07-09 23:01:15 +02:00
You can now access the web vault in your browser at `https://localhost:8080`. You can adjust your API endpoint settings in `src/app/services/services.module.ts` by altering the `apiService.setUrls` call. For example:
2018-07-09 23:02:03 +02:00
```typescript
2018-07-09 23:01:15 +02:00
await apiService.setUrls({
base: isDev ? null : window.location.origin,
api: isDev ? 'http://mylocalapi' : null,
identity: isDev ? 'http://mylocalidentity' : null,
});
```
If you want to run a production build of the web vault (pointed to the production API), run:
```
npm run build:prod:watch
```
2016-10-02 05:32:12 +02:00
# Contribute
Code contributions are welcome! Please commit any pull requests against the `master` branch.
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.