Change webpack to only copy the html files to popup/app. Update readme with more instructions for building. (#336)
This commit is contained in:
parent
5439a2b33e
commit
77f9270131
19
README.md
19
README.md
|
@ -27,10 +27,10 @@ The bitwarden browser extension is written using the Chrome Web Extension API an
|
||||||
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 `src/services/apiService.js` and set `self.baseUrl` and `self.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 `src/services/apiService.js` and set `self.baseUrl` and `self.identityBaseUrl` to your local API instance (ex. `http://localhost:5000`).
|
||||||
|
|
||||||
Then run the following commands:
|
Then run the following commands:
|
||||||
|
```bash
|
||||||
- `npm install`
|
npm install
|
||||||
- `gulp build`
|
npm run dev:watch
|
||||||
- `npm run dev:watch`
|
```
|
||||||
|
|
||||||
You can now load the extension into your browser through the browser's extension tools page:
|
You can now load the extension into your browser through the browser's extension tools page:
|
||||||
|
|
||||||
|
@ -42,6 +42,17 @@ You can now load the extension into your browser through the browser's extension
|
||||||
1. Type `about:debugging` in your address bar to bring up the add-ons page.
|
1. Type `about:debugging` in your address bar to bring up the add-ons page.
|
||||||
2. Click the `Load Temporary Add-on` button, navigate to the `dist/manifest.json` file, and "Open".
|
2. Click the `Load Temporary Add-on` button, navigate to the `dist/manifest.json` file, and "Open".
|
||||||
|
|
||||||
|
### Release
|
||||||
|
|
||||||
|
To build the the extension for production the following commands should be run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run prod
|
||||||
|
gulp dist:[browser]
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `[browser]` is the web browser to target. Currently the following web browsers are supported: `chrome`, `edge`, `firefox` and `opera`.
|
||||||
|
|
||||||
# Contribute
|
# 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`](CONTRIBUTING.md) file.
|
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.
|
||||||
|
|
|
@ -3,9 +3,9 @@
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start:firefox": "web-ext run --source-dir ./dist/",
|
"start:firefox": "web-ext run --source-dir ./dist/",
|
||||||
"dev": "webpack --config webpack.dev.js",
|
"dev": "gulp build && webpack --config webpack.dev.js",
|
||||||
"dev:watch": "webpack --config webpack.dev.js --watch",
|
"dev:watch": "gulp build && webpack --config webpack.dev.js --watch",
|
||||||
"prod": "webpack --config webpack.prod.js"
|
"prod": "gulp build && webpack --config webpack.prod.js"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"angular": "1.6.6",
|
"angular": "1.6.6",
|
||||||
|
|
|
@ -73,7 +73,11 @@ module.exports = {
|
||||||
new CopyWebpackPlugin([
|
new CopyWebpackPlugin([
|
||||||
// Temporarily copy the whole app folder, can be removed once
|
// Temporarily copy the whole app folder, can be removed once
|
||||||
// the templates uses template rather than using templateUrl.
|
// the templates uses template rather than using templateUrl.
|
||||||
{ from: './src/popup/app', to: 'popup/app' },
|
{
|
||||||
|
context: 'src/popup/app',
|
||||||
|
from: '**/*.html',
|
||||||
|
to: 'popup/app'
|
||||||
|
},
|
||||||
'./src/manifest.json',
|
'./src/manifest.json',
|
||||||
{ from: './src/_locales', to: '_locales' },
|
{ from: './src/_locales', to: '_locales' },
|
||||||
{ from: './src/edge', to: 'edge' },
|
{ from: './src/edge', to: 'edge' },
|
||||||
|
|
Loading…
Reference in New Issue