Skip to content

starter project for making a chrome extension with typescript, solidjs, and vite for build tool

Notifications You must be signed in to change notification settings

scootyboots/solid-chrome-extension-template

Repository files navigation

Solidjs Chrome Extension Template

This is a starter project for making a chrome extension using typescript and solidjs - using vite for the build tool.

It utilizes CRXJS to do the heavy lifting for configuring vite to build the necessary files for a chrome extension.

CRXJS uses the chrome manifest to discover the entry files needed for the extension, it's pretty cool stuff. Check out the docs for a better explanation.

npm run dev has been a bit buggy for me, when in doubt just opt for npm run build

Usage

Those templates dependencies are maintained via pnpm via pnpm up -Lri.

This is the reason you see a pnpm-lock.yaml. That being said, any package manager will work. This file can be safely be removed once you clone a template.

$ npm install # or pnpm install or yarn install

Learn more on the Solid Website and come chat with us on our Discord

Available Scripts

In the project directory, you can run:

npm dev or npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

npm run build

Builds the app for production to the dist folder.
It correctly bundles Solid in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Deployment

You can deploy the dist folder to any static host provider (netlify, surge, now, etc.)

About

starter project for making a chrome extension with typescript, solidjs, and vite for build tool

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published