SurfSense/extension/README.md

71 lines
1,014 B
Markdown
Raw Normal View History

2024-08-12 00:32:42 -07:00
# Chrome Extension TypeScript Starter
![build](https://github.com/chibat/chrome-extension-typescript-starter/workflows/build/badge.svg)
Chrome Extension, TypeScript and Visual Studio Code
## Prerequisites
* [node + npm](https://nodejs.org/) (Current Version)
## Option
* [Visual Studio Code](https://code.visualstudio.com/)
## Includes the following
* TypeScript
* Webpack
* React
* Jest
* Example Code
* Chrome Storage
* Options Version 2
* content script
* count up badge number
* background
## Project Structure
* src/typescript: TypeScript source files
* src/assets: static files
* dist: Chrome Extension directory
* dist/js: Generated JavaScript files
## Setup
```
npm install
```
## Import as Visual Studio Code project
...
## Build
```
npm run build
```
## Build in watch mode
### terminal
```
npm run watch
```
### Visual Studio Code
Run watch mode.
type `Ctrl + Shift + B`
## Load extension to chrome
Load `dist` directory
## Test
`npx jest` or `npm run test`