Initial commit

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Test
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 18
+            # Install dependencies
+            - run: npm ci
+            # Build
+            - run: npm run build
+            # Test
+            - run: npm run check

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["svelte.svelte-vscode"]
+}

README.md

@@ -0,0 +1,43 @@
+# Svelte Typescript Chrome Extension Boilerplate
+
+> Boilerplate for Chrome Extension Svelte Typescript project
+
+## Features
+
+-   [Svelte](https://svelte.dev/)
+-   [TypeScript](https://www.typescriptlang.org/)
+-   [Vite](https://vitejs.dev/)
+-   [CRXJS Vite Plugin](https://github.com/crxjs/chrome-extension-tools/blob/main/packages/vite-plugin/README.md)
+-   [Chrome Extensions Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/)
+
+## Examples of integrations
+
+-   [Tailwind CSS](https://tailwindcss.com/) – is in the [tailwindcss](https://github.com/NekitCorp/chrome-extension-svelte-typescript-boilerplate/tree/tailwindcss) branch
+
+## Development
+
+```bash
+# install dependencies
+npm i
+
+# build files to `/dist` directory
+# HMR for extension pages and content scripts
+npm run dev
+```
+
+## Build
+
+```bash
+# build files to `/dist` directory
+$ npm run build
+```
+
+## Load unpacked extensions
+
+[Getting Started Tutorial](https://developer.chrome.com/docs/extensions/mv3/getstarted/)
+
+1. Open the Extension Management page by navigating to `chrome://extensions`.
+2. Enable Developer Mode by clicking the toggle switch next to `Developer mode`.
+3. Click the `LOAD UNPACKED` button and select the `/dist` directory.
+
+![Example](https://wd.imgix.net/image/BhuKGJaIeLNPW9ehns59NfwqKxF2/vOu7iPbaapkALed96rzN.png?auto=format&w=571)