Skip to content

EastSun5566/create-chrome-ext

Repository files navigation

Create Chrome Extension (.crx)

crx-preview

OSCS Status npm npm-download GitHub Language Count npm publish

Scaffolding your chrome extension, multiple boilerplates supported!

  • 馃殌 Lightning Fast HMR(use Vite2)
  • 馃ァ Out of Box
  • 馃寛 Multiple Frontend Framework Supported (9+)
  • 馃ア Multiple Language Supported (TypeScript & JavaScript)
  • 馃Ф Optimized Builds
  • 馃寳 Light & Dark Mode

EN涓枃

Installing

Node >= 14.18.0

# use npm-create command, or use pnpm | yarn
位 npm create chrome-ext

# or use npx command
位 npx create-chrome-ext

# or use npm-init command
位 npm init chrome-ext

Usage

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Vite + Svelte project, run:

# npm 6.x
位 npm create chrome-ext@latest my-crx-app --template svelte-js

# or npm 7+, extra double-dash is needed:
位 npm create chrome-ext@latest my-crx-app -- --template react-ts

# or yarn
位 yarn create chrome-ext my-crx-app --template vue-ts

# or pnpm
位 pnpm create chrome-ext my-crx-app --template vanilla-ts

You can also generator the project with crx cli, run:

位 npm install create-chrome-ext --global

# and then
位 crx my-crx-app
# or
位 crx my-crx-app --template preact-js
# or use create-chrome-exe (global env)
位 create-chrome-ext my-crx-app

Supported Templates

framework presets include:

ReactVueSveltePreactSolidAlpineLitInfernoStencilVanilla

languages supported:

JavaScriptTypeScript

Preview

crx-run crx-install crx-build

About

馃嵑 Scaffolding your Chrome extension! Boilerplates: react \ vue \ svelte \ solid \ preact \ alpine \ lit \ stencil \ inferno \ vanilla

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 30.2%
  • CSS 23.8%
  • TypeScript 23.8%
  • HTML 13.8%
  • Svelte 3.9%
  • Vue 3.5%
  • Mustache 1.0%