mirror of
https://github.com/BetterSEQTA/BetterSEQTA-Plus.git
synced 2026-06-05 19:24:39 +00:00
update readme
This commit is contained in:
@@ -47,58 +47,48 @@
|
|||||||
git clone https://github.com/SethBurkart123/EvenBetterSEQTA
|
git clone https://github.com/SethBurkart123/EvenBetterSEQTA
|
||||||
```
|
```
|
||||||
|
|
||||||
### Windows
|
### Running Development
|
||||||
|
|
||||||
Open the `install.bat` file located inside the `scripts` folder. Then after that is finished, open the `dev.bat` file.
|
|
||||||
|
|
||||||
### Mac & Linux
|
|
||||||
|
|
||||||
1. `cd` into the seqta folder
|
|
||||||
```
|
|
||||||
cd EvenBetterSEQTA/scripts
|
|
||||||
```
|
|
||||||
2. Make the scripts in the folder executable
|
|
||||||
```
|
|
||||||
chmod a+x *
|
|
||||||
```
|
|
||||||
3. Run the install and dev scripts
|
|
||||||
```
|
|
||||||
sh install.sh
|
|
||||||
```
|
|
||||||
4. Open a new terminal session to let the new command activate, then run
|
|
||||||
```
|
|
||||||
sh dev.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
### Manual
|
|
||||||
|
|
||||||
1. Install dependencies
|
1. Install dependencies
|
||||||
|
|
||||||
```
|
```
|
||||||
npm install
|
npm install # or your preferred package manager like pnpm or yarn
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install webpack
|
2. Run the dev script (it updates as you save files)
|
||||||
|
|
||||||
```
|
|
||||||
npm install -g webpack
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Run the dev script (it updates as you save files)
|
|
||||||
|
|
||||||
```
|
```
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Install and run the dev script for the interface **at the same time** (all custom react components are a separate sub-repository)
|
3. Load the extension into chrome
|
||||||
|
|
||||||
|
- Go to `chrome://extensions`
|
||||||
|
- Enable developer mode
|
||||||
|
- Click `Load unpacked`
|
||||||
|
- Select the `dist` folder
|
||||||
|
|
||||||
|
Just remember, in order to update changes to the extension, you need to click the refresh button on the extension in `chrome://extensions` whenever anything's changed.
|
||||||
|
|
||||||
|
### Building for production
|
||||||
|
|
||||||
|
1. Install dependencies
|
||||||
|
|
||||||
```
|
```
|
||||||
cd interface
|
npm install # or your preferred package manager like pnpm or yarn
|
||||||
|
|
||||||
npm install
|
|
||||||
npm run dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
2. Run the build script
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Package it up (optional)
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run package # this requires 7zip to be installed in order to work
|
||||||
|
```
|
||||||
|
|
||||||
## Folder Structure
|
## Folder Structure
|
||||||
|
|
||||||
|
|||||||
+2
-1
@@ -6,7 +6,8 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "parcel watch manifest.json --host localhost --config @parcel/config-webextension --no-hmr --no-content-hash",
|
"dev": "parcel watch manifest.json --host localhost --config @parcel/config-webextension --no-hmr --no-content-hash",
|
||||||
"build": "parcel build manifest.json --config @parcel/config-webextension --no-content-hash",
|
"build": "parcel build manifest.json --config @parcel/config-webextension --no-content-hash",
|
||||||
"eslint": "eslint --fix ."
|
"eslint": "eslint --fix .",
|
||||||
|
"package": "7z a -tzip extension.zip ./build/*"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "",
|
||||||
|
|||||||
Reference in New Issue
Block a user