/chrome-extension-starter

Starter project for building Chrome extensions using SCSS and Typescript.

Primary LanguageJavaScript

Chrome extension starter project

The goal of this project is to allow you to quickly start creating extensions for Chrome using typescript and sass.

Workflow

To start working on project use command below, it will start live server, and automaticly update extension

npm run start
or
yarn start

To build extension

npm run build
or
yarn build

To build production version

npm run build:prod
or
yarn build:prod

Project structure

src
├── index.html  <- main file of extension popup
├── manifest.json  <- chrome extension configuration file
├── background
│   └── background.ts  <- entry point for background bundle
├── content
│   ├── assets
│   │   └── scss
│   │       └── content.scss  <- entry point for content styles
│   └── content.ts  <- entry point for content bundle
├── popup
│   ├── assets
│   │   └── popup.scss  <- entry point for popup window styles
│   └── popup.ts  <- entry point for popup bundle
└── shared  <- directory with shared parts of project like utils etc.

You can read more about manifest.json and extension configuration at: https://developer.chrome.com/docs/extensions/mv2/manifest/