An open API service indexing awesome lists of open source software.

https://github.com/divshekhar/web-extension-template

Template for developing Web Extension using TypeScript.
https://github.com/divshekhar/web-extension-template

chrome-extension-boilerplate chrome-extension-jest chrome-extension-react chrome-extension-starter chrome-extension-template chrome-extension-typescript chrome-extension-webpack web-extension-starter

Last synced: 11 months ago
JSON representation

Template for developing Web Extension using TypeScript.

Awesome Lists containing this project

README

          


Web Extension Template

# Web Extension Template

![build](https://github.com/divshekhar/web-extension-template/workflows/build/badge.svg)

Template for developing Chrome Web Extension using TypeScript.

## :sparkle: Template Includes

* TypeScript
* Webpack
* React
* Jest
* ES Lint
* Prettier
* Husky
* Example
* Popup (Hello World)

## :open_file_folder: Project Structure

* **src/**: TypeScript source files
* **src/assets**: Static files
* **src/assets/images/**: Image files
* **dist**: Chrome Extension directory
* **dist/scripts**: Generated JavaScript files

## :hammer: Setup

```bash
npm install
```

## :shield: Build

```bash
npm run build
```

## :eye_speech_bubble: Watch mode

```bash
npm run watch
```

### :vs: Visual Studio Code

Run watch mode.

type `Ctrl + Shift + B`

## :computer: Load extension to chrome

Load `dist` directory

## :gear: Test

`npx jest` or `npm run test`