From 481594a01a0b696565da514a11dd4b6305da976e Mon Sep 17 00:00:00 2001 From: Samet Date: Tue, 21 May 2024 12:44:17 +0300 Subject: [PATCH] docs: added readme file --- README.md | 75 +++++++------------------------------------------------ 1 file changed, 9 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 0e6083a..1ccd130 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,15 @@ -# TypeScript React Chrome Extension Boilerplate +## AlertUp -A basic TypeScript React Chrome Extension boilerplate that gets you started quickly. It supports **TypeScript**, **JSX**, and **automatic reloading** during development. Jest, ESLint and Prettier included, all bundled using [Rollup](https://rollupjs.org/guide/en/) and [`rollup-plugin-chrome-extension`](https://extend-chrome.dev/rollup-plugin). +Time to ditch RSS readers. Get alerts for your saved searchs on Upwork by just one click. -## Get Started +![Chrome Web Store](https://img.shields.io/chrome-web-store/v/kceaejcahcendbhocehkokcddakdoidh?label=Chrome%20Web%20Store&style=for-the-badge) -### Using `create-react-crx` +### Get Started -Type this into your terminal: +This project uses [crx-base](`https://github.com/sametcodes/crx-base`) as a base. You can find more information about how to get started and how to build the project in the documentation. -```sh -npx create-react-crx -``` - -Follow the prompts to setup your Chrome extension project. - -### Using `git clone` - -Type this into your terminal: - -```sh -git clone https://github.com/extend-chrome/ts-react-boilerplate.git my-chrome-extension -cd my-chrome-extension -npm install -``` - -> 🖌️ Update your package name and version in `package.json` before you get started! - -### Development - -For development with automatic reloading: - -```sh -npm run start -``` - -Open the [Extensions Dashboard](chrome://extensions), enable "Developer mode", click "Load unpacked", and choose the `dist` folder. - -When you make changes in `src` the background script and any content script will reload automatically. - -### Production - -When it's time to publish your Chrome extension, make a production build to submit to the Chrome Web Store. This boilerplate will use the version in `package.json`, unless you add a version to `src/manifest.json`. - -> Make sure you have updated the name and version of your extension in `package.json`. - -Run the following line: - -```sh -npm run build -``` - -This will create a ZIP file with your package name and version in the `releases` -folder. - -## Source Layout - -Your manifest is at `src/manifest.json`, and Rollup will bundle any files you -include here. All the filepaths in your manifest should point to files in `src`. - -## Features - -- Uses Rollup to bundle your extension -- Chrome Extension automatic reloader -- Jest configuration for testing - -## Resources - -[Chrome Extension official documentation](https://developer.chrome.com/docs/webstore/) - -[How to Publish your extension step by step video tutorial](https://www.youtube.com/playlist?list=PLYlOQabA4Mm0bPiMKIBMgZK0u2jbYsrC6) +### Download + + + \ No newline at end of file