https://github.com/axel-dev/angular-webextension-starter
Angular WebExtension starter kit
https://github.com/axel-dev/angular-webextension-starter
angular gulp starter-kit webextension
Last synced: 4 months ago
JSON representation
Angular WebExtension starter kit
- Host: GitHub
- URL: https://github.com/axel-dev/angular-webextension-starter
- Owner: AXeL-dev
- License: mpl-2.0
- Created: 2019-12-29T20:45:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T11:26:23.000Z (almost 3 years ago)
- Last Synced: 2023-03-07T06:37:50.871Z (almost 3 years ago)
- Topics: angular, gulp, starter-kit, webextension
- Language: JavaScript
- Homepage:
- Size: 2.99 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular WebExtension starter
A minimal starter kit to quickly get started on your [Angular](https://angular.io/) based webextension(s), made with [Gulp](https://gulpjs.com/).
## Installation
Open a terminal & clone this repository using git:
```
git clone https://github.com/AXeL-dev/angular-webextension-starter.git
```
Then install all the dependencies using npm:
```
cd angular-webextension-starter && npm install
```
Finally, make sure that both **Angular** & **Gulp** CLIs are installed:
```
npm install -g @angular/cli gulp-cli
```
## Usage
```
gulp new --name
```
**Arguments:**
argument | default | description
----------------- | --------- | ---------------------
**--name** | - | WebExtension name
**--ver** | 0.0.0 | WebExtension version
**--author** | - | Author name
**--url** | - | Homepage url
**--skipTests** | false | When true, does not generate `spec.ts` test files for the new extension
:warning: All the newly created extensions will be under the `output` folder.
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Package
Make sure you have the following package installed `npm install -g web-ext`. Then run:
```
npm run build && npm run package
```
## Load in browser
Make sure to build the extension first before trying to load it in your browser.
### Firefox:
Navigate to `about:debugging`
### Chrome:
Navigate to chrome extensions
## Contributing
Read [contributing guidelines](https://github.com/AXeL-dev/contributing/blob/master/README.md).
## License
This project is licensed under the [MPL2](LICENSE) license.