Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/talljack/chrome-extension-starter
https://github.com/talljack/chrome-extension-starter
Last synced: about 20 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/talljack/chrome-extension-starter
- Owner: Talljack
- License: mit
- Created: 2023-03-22T11:01:00.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T11:39:59.000Z (about 1 year ago)
- Last Synced: 2024-05-01T19:59:44.297Z (9 months ago)
- Language: TypeScript
- Size: 562 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chrome Extension Starter Template
This is a starter template for building a Chrome Extension. It includes a basic manifest file and a popup page.
## Prerequisites
- [Node.js](https://nodejs.org/en/)
- [NPM](https://www.npmjs.com/)
## Includes the following
- [Vite](https://vitejs.dev/)
- [React](https://reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Vitest](https://vitest.dev/)
- Example Code
- Storage
- content script
- background script
- popup page
- options page
## Getting Started
1. Use this template to create a new repository
2. Use Vscode to open the project
3. setup the project
```bash
pnpm install
```
## Build
```bash
pnpm build
```
## Watch
```bash
pnpm run watch
```
## Load extension to Chrome
1. Open the Extension Management page by navigating to chrome://extensions.
2. Load `dist` directory
## Test
some test files in `/src/background/test` directory, you can write your owner tests.
```bash
pnpm test
```