https://github.com/shin4488/financial-statement-chrome-extension

accounting chrome-extension finance react

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/shin4488/financial-statement-chrome-extension
Owner: shin4488
License: mit
Created: 2024-10-14T03:59:28.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-10-19T13:15:18.000Z (8 months ago)
Last Synced: 2024-10-19T14:05:10.672Z (8 months ago)
Topics: accounting, chrome-extension, finance, react
Language: TypeScript
Homepage: https://chromewebstore.google.com/detail/jjjlnbhaimbljpnohoelnodggfdoimee
Size: 291 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  


 

  


  

    Browser Extension 


    React & TypeScript Starter

    


  



A cross-platform (Chrome, Firefox, Edge, Opera, Brave) web browser extension (Manifest V3 and Manifest V2) starter kit with hot reload support, built with React, Typescript, Redux, Vite, ESLint, Prettier, TailwindCSS, Jest and more! 





  

    

  

     

  

    

  

     

  

    

  





  Features ·

  Quick Start ·

  Important Notes ·

  License



> 🚀 **NEW** (experimental) Zustand for state management instead Redux, with [`webext-zustand`](https://github.com/sinanbekar/webext-zustand) package. You can try it now on the branch [`experimental-zustand`](https://github.com/sinanbekar/browser-extension-react-typescript-starter/tree/experimental-zustand)

## Features

- **Instant HMR** (hot reload)[^1]

- Write once run on any browser

- Global Redux support with persist option. Effortless communication between content, background, popup, options, and more pages.

- Provides a basic content example and popup, options, and welcome pages with all React

- Latest Manifest V3 support

- Manifest V2 support (beta)

- Dynamic manifest.json

- Includes ESLint configured to work with TypeScript and Prettier

- Includes tests with Jest

#### Built with

- React

- TypeScript

- Redux (toolkit and redux-persist)

- TailwindCSS

- Vite

- Jest

- ESLint

- Prettier

- simple-git-hooks (lightweight husky alternative)

- nano-staged

[^1]: While it is fully supported and stable in most cases, hard reloading is rarely recommended.

## Browser Support

| [![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](/) | [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](/) | [![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](/) | [![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)](/) | [![Brave](https://raw.github.com/alrra/browser-logos/master/src/brave/brave_48x48.png)](/) |

| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |

| ✔                                                                                             | ✔ (Beta)                                                                                         | ✔                                                                                       | ✔                                                                                          | ✔                                                                                          |

## Quick Start

Ensure you have

- [Node.js](https://nodejs.org) 16 or later installed

- [Yarn](https://yarnpkg.com) installed

### Use the Template

#### GitHub Template

[Create a repo from this template on GitHub](https://github.com/sinanbekar/browser-extension-react-typescript-starter/generate).

**_or_**

#### Clone to local

If you prefer to do it manually with the cleaner git history

> **Note** If you don't have yarn installed, run: npm install -g yarn

```bash

npx degit sinanbekar/browser-extension-react-typescript-starter my-web-extension

cd my-web-extension

git init

```

Then run the following:

- `yarn install` to install dependencies.

- `yarn dev` to start the development server.

- `yarn build` to build an unpacked extension.

- **Load extension in Chrome (Chromium, Manifest V3)**

  - Go to the browser address bar and type `chrome://extensions`

  - Check the `Developer Mode` button to enable it.

  - Click on the `Load Unpacked Extension` button.

  - Select your `dist` folder in the project root.

- **Load extension in Firefox (Manifest V2)**

  - Go to the browser address bar and type `about://debugger`

  - Click on the `Load Temporary Add-on` button.

  - Select your `dist-firefox-v2` folder in the project root.

### Available Commands

- `yarn clean` to remove dist folder. `dev` and `build` commands call this command.

- `yarn format` to fix code with eslint and prettier.

- `yarn lint` to call ESLint and Prettier.

- `yarn test` for testing.

### Redux

You can use redux (redux-toolkit) as state manager between popup, background, content and custom pages. Read the documentation for more.

#### [@eduardoac-skimlinks/webext-redux](https://github.com/eduardoacskimlinks/webext-redux)

### Bundling

#### [@crxjs/vite-plugin](https://github.com/crxjs/chrome-extension-tools)

> **Note** This plugin powers the development side of this starter.

>

> docs: https://crxjs.dev/vite-plugin

>

> Special thanks to [@jacksteamdev](https://github.com/jacksteamdev) and contributors for this amazing plugin.

## Contributing

This repository is following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.

## License

MIT © [Sinan Bekar](https://sinan.engineer)