generated from Jonghakseo/chrome-extension-boilerplate-react-vite
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from Jonghakseo/dev
v0.1.0
- Loading branch information
Showing
52 changed files
with
2,310 additions
and
422 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
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 |
---|---|---|
@@ -1,89 +1,3 @@ | ||
<div align="center"> | ||
<img src="public/icon-128.png" alt="logo"/> | ||
<h1> Chrome Extension Boilerplate with<br/>React + Vite + TypeScript</h1> | ||
# DragGPT | ||
|
||
![](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.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) | ||
- [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/) | ||
- HMR(incomplete) | ||
- [Refresh PR](https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite/pull/25) | ||
|
||
## 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"> | ||
|
||
|
||
## 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) | ||
|
||
|
||
|
||
--- | ||
## 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/) | ||
made by [chrome-extension-boilerplate-react-vite](https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite) |
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.