https://github.com/ospoon/create-extension-js

Create a new browser extension based on extension.js.
https://github.com/ospoon/create-extension-js

Last synced: about 1 month ago
JSON representation

Create a new browser extension based on extension.js.

• Host: GitHub
• URL: https://github.com/ospoon/create-extension-js
• Owner: OSpoon
• License: mit
• Created: 2024-06-17T13:34:09.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-08T09:53:02.000Z (4 months ago)
• Last Synced: 2024-08-09T12:47:55.564Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.3 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# create-extension-js

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![bundle][bundle-src]][bundle-href]

[![JSDocs][jsdocs-src]][jsdocs-href]

[![License][license-src]][license-href]

> ⚠️ **Warning:** The project is in the planning stage.

Scaffolding Your First Browser Extension based on [**Extension.js**](https://github.com/extension-js/extension.js)

With NPM:

```shell

$ npm create extension-js@latest

```

Then follow the prompts!

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 React + NewTab + Tailwind project, run:

```shell

# npm 7+, extra double-dash is needed:

npm create extension-js@latest my-react-ext -- --template react-newtab-tailwind

npm create extension-js@latest my-react-ext -- --template react,newtab,tailwind

```

Currently supported template presets include:

[Discuss how to support template composition?](https://github.com/extension-js/extension.js/discussions/93)

## License

[MIT](./LICENSE) License © 2023-PRESENT [OSpoon](https://github.com/ospoon)

[npm-version-src]: https://img.shields.io/npm/v/create-extension-js?style=flat&colorA=080f12&colorB=1fa669

[npm-version-href]: https://npmjs.com/package/create-extension-js

[npm-downloads-src]: https://img.shields.io/npm/dm/create-extension-js?style=flat&colorA=080f12&colorB=1fa669

[npm-downloads-href]: https://npmjs.com/package/create-extension-js

[bundle-src]: https://img.shields.io/bundlephobia/minzip/create-extension-js?style=flat&colorA=080f12&colorB=1fa669&label=minzip

[bundle-href]: https://bundlephobia.com/result?p=create-extension-js

[license-src]: https://img.shields.io/github/license/ospoon/create-extension-js.svg?style=flat&colorA=080f12&colorB=1fa669

[license-href]: https://github.com/ospoon/create-extension-js/blob/main/LICENSE

[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669

[jsdocs-href]: https://www.jsdocs.io/package/create-extension-js