generated from Jonghakseo/chrome-extension-boilerplate-react-vite
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit a6138fe
Showing
66 changed files
with
6,237 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es6": true, | ||
"node": true | ||
}, | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:react/recommended", | ||
"plugin:@typescript-eslint/recommended", | ||
"plugin:prettier/recommended" | ||
], | ||
"parser": "@typescript-eslint/parser", | ||
"parserOptions": { | ||
"ecmaFeatures": { | ||
"jsx": true | ||
}, | ||
"ecmaVersion": "latest", | ||
"sourceType": "module" | ||
}, | ||
"plugins": ["react", "@typescript-eslint"], | ||
"settings": { | ||
"react": { | ||
"version": "detect" | ||
} | ||
}, | ||
"rules": { | ||
"react/react-in-jsx-scope": "off" | ||
}, | ||
"globals": { | ||
"chrome": "readonly" | ||
}, | ||
"ignorePatterns": ["watch.js", "dist/**"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "npm" # See documentation for possible values | ||
directory: "/" # Location of package manifests | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Build And Upload Extension Zip Via Artifact | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
|
||
jobs: | ||
build: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
cache: 'yarn' | ||
|
||
- uses: actions/cache@v3 | ||
with: | ||
path: node_modules | ||
key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }} | ||
|
||
- run: yarn install | ||
|
||
- run: yarn build | ||
|
||
- uses: actions/upload-artifact@v3 | ||
with: | ||
path: dist/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: Greetings | ||
|
||
on: [pull_request_target, issues] | ||
|
||
jobs: | ||
greeting: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
steps: | ||
- uses: actions/first-interaction@v1 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
issue-message: 'Thank you for your contribution. We will check and reply to you as soon as possible.' | ||
pr-message: 'Thank you for your contribution. We will check and reply to you as soon as possible.' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Test | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
cache: 'yarn' | ||
|
||
- uses: actions/cache@v3 | ||
with: | ||
path: node_modules | ||
key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }} | ||
|
||
- run: yarn install | ||
|
||
- run: yarn test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# dependencies | ||
/node_modules | ||
|
||
# testing | ||
/coverage | ||
|
||
# build | ||
/dist | ||
|
||
# etc | ||
.DS_Store | ||
.env.local | ||
.idea | ||
|
||
# compiled | ||
utils/reload/*.js | ||
utils/reload/injections/*.js | ||
public/manifest.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
18.12.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"singleQuote": false, | ||
"trailingComma": "es5", | ||
"arrowParens": "always" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2022 Seo Jong Hak | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
<div align="center"> | ||
<img src="public/icon-128.png" alt="logo"/> | ||
<h1> Chrome Extension Boilerplate with<br/>React + Vite + TypeScript</h1> | ||
|
||
![](https://img.shields.io/badge/React-61DAFB?style=flat-square&logo=react&logoColor=black) | ||
![](https://img.shields.io/badge/Typescript-3178C6?style=flat-square&logo=typescript&logoColor=white) | ||
![](https://badges.aleen42.com/src/vitejs.svg) | ||
![GitHub action badge](https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite/actions/workflows/build-zip.yml/badge.svg) | ||
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/Jonghakseo/chrome-extension-boilerplate-react-viteFactions&count_bg=%23#222222&title_bg=%23#454545&title=😀&edge_flat=true" alt="hits"/> | ||
|
||
|
||
> This project is listed in the [Awesome Vite](https://github.com/vitejs/awesome-vite) | ||
</div> | ||
|
||
## Table of Contents | ||
|
||
- [Intro](#intro) | ||
- [Features](#features) | ||
- [Installation](#installation) | ||
- [Procedures](#procedures) | ||
- [Screenshots](#screenshots) | ||
- [NewTab](#newtab) | ||
- [Popup](#popup) | ||
- [Sample](#sample) | ||
- [Documents](#documents) | ||
|
||
## Intro <a name="intro"></a> | ||
This boilerplate is made for creating chrome extensions using React and Typescript. | ||
> The focus was on improving the build speed and development experience with Vite. | ||
## Features <a name="features"></a> | ||
- [React 18](https://reactjs.org/) | ||
- [TypeScript](https://www.typescriptlang.org/) | ||
- [Jest](https://jestjs.io/) | ||
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) | ||
- [Vite](https://vitejs.dev/) | ||
- [SASS](https://sass-lang.com/) | ||
- [ESLint](https://eslint.org/) | ||
- [Prettier](https://prettier.io/) | ||
- [Chrome Extension Manifest Version 3](https://developer.chrome.com/docs/extensions/mv3/intro/) | ||
- HRR(Hot Rebuild & Refresh/Reload) | ||
|
||
## Installation <a name="installation"></a> | ||
|
||
### Procedures <a name="procedures"></a> | ||
1. Clone this repository. | ||
2. Change `name` and `description` in package.json => **Auto synchronize with manifest** | ||
3. Run `yarn install` or `npm i` (check your node version >= 16.6, recommended >= 18) | ||
4. Run `yarn dev` or `npm run dev` | ||
5. Load Extension on Chrome | ||
1. Open - Chrome browser | ||
2. Access - chrome://extensions | ||
3. Check - Developer mode | ||
4. Find - Load unpacked extension | ||
5. Select - `dist` folder in this project (after dev or build) | ||
6. If you want to build in production, Just run `yarn build` or `npm run build`. | ||
|
||
## Screenshots <a name="screenshots"></a> | ||
|
||
### New Tab <a name="newtab"></a> | ||
|
||
<img width="971" src="https://user-images.githubusercontent.com/53500778/162631646-cd40976b-b737-43d0-8e6a-6ac090a2e2d4.png"> | ||
|
||
### Popup <a name="popup"></a> | ||
|
||
<img width="314" alt="popup" src="https://user-images.githubusercontent.com/53500778/203561728-23517d46-12e3-4139-8a4f-e0b2f22a6ab3.png"> | ||
|
||
## Sample <a name="sample"></a> | ||
- https://github.com/Jonghakseo/drag-gpt-extension | ||
- https://github.com/Jonghakseo/pr-commit-noti | ||
|
||
## Documents <a name="documents"></a> | ||
- [Vite Plugin](https://vitejs.dev/guide/api-plugin.html) | ||
- [ChromeExtension](https://developer.chrome.com/docs/extensions/mv3/) | ||
- [Rollup](https://rollupjs.org/guide/en/) | ||
- [Rollup-plugin-chrome-extension](https://www.extend-chrome.dev/rollup-plugin) | ||
|
||
|
||
## Star History | ||
|
||
[![Star History Chart](https://api.star-history.com/svg?repos=Jonghakseo/chrome-extension-boilerplate-react-vite&type=Date)](https://star-history.com/#Jonghakseo/chrome-extension-boilerplate-react-vite&Date) | ||
|
||
|
||
|
||
--- | ||
## Thanks To | ||
|
||
| [Jetbrains](https://jb.gg/OpenSourceSupport) | [Jackson Hong](https://www.linkedin.com/in/j-acks0n/) | | ||
|--------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| | ||
| <img width="100" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo."> | <img width="100" src='https://avatars.githubusercontent.com/u/23139754?v=4' alt='Jackson Hong'/> | | ||
|
||
|
||
--- | ||
|
||
[Jonghakseo](https://nookpi.tistory.com/) |
Oops, something went wrong.