https://github.com/room-js/chrome-extension-ts-starter

Chrome Extension starter built with TypeScript
https://github.com/room-js/chrome-extension-ts-starter

Last synced: 4 months ago
JSON representation

Chrome Extension starter built with TypeScript

• Host: GitHub
• URL: https://github.com/room-js/chrome-extension-ts-starter
• Owner: room-js
• License: mit
• Created: 2020-05-25T20:34:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T09:42:45.000Z (8 months ago)
• Last Synced: 2024-08-01T16:39:03.126Z (7 months ago)
• Language: TypeScript
• Homepage: https://www.youtube.com/watch?v=01vp9cYbQus
• Size: 1.98 MB
• Stars: 84
• Watchers: 2
• Forks: 27
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# chrome-extension-ts-starter

It is a boilerplate for a Chrome Extension built with TypeScript and Parcel.

## This starter consists of the following parts

* Background script (vanilla TS)

* Content script (vanilla TS)

* Options page (Vue.js, Sass)

* Popup page (Vue.js, Sass)

* DevTools panel page (React.js, Styled Components)

_And, of course, the `./manifest.json` file describing its configuration._

## Environment

* Node.js >=12.0.0

* NPM >= 6.0.0

_Most probably it will work with earlier versions too but I didn't test it._

## Testing

`Jest` is included and ready for the vanilla TS parts. Testing for React/Vue is not included in order to keep the Jest config clean.

## Scripts

* `npm run dist` - build the extension into `./dist` folder

* `npm run lint` - ESLint for `.ts` and `.tsx` files

* `npm run test` - Jest unit tests