2.0.0

- update Google Identity API - update build script - update dependency - update doc - update extension manifest to V3
J-Siu · Jun 16, 2023 · 8a911dc · 8a911dc
1 parent b6f176a
commit 8a911dc
Show file tree

Hide file tree

Showing 70 changed files with 1,119 additions and 847 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 TODO.md
 lib/app/ui/api.dart
 pubspec.lock
-pubspec.yaml
+/pubspec.yaml
 scripts/.current.*
 web/index.html
 web/manifest.json

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+- 2.0.0
+  - update Google Identity API
+  - update build script
+  - update dependency
+  - update doc
+  - update extension manifest to V3
 - 1.0.28
   - Fix #3, blank page
 - 1.0.27

diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
 # Pin2Me [![Paypal donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/donate/?business=HZF49NM9D35SJ&no_recurring=0&currency_code=CAD)
 
 Pin website to New Tab page from any device, any browser! Support Import/Export without sign-in.
+
 ### Table Of Content
+
 <!-- TOC -->
 
 - [Table Of Content](#table-of-content)
@@ -42,12 +44,12 @@ Pin website to New Tab page from any device, any browser! Support Import/Export
 
 ### Platform
 
-Platform|Link
----|---
-Web|https://pin2me.dev/
-Demo|https://j-siu.github.io/app/pin2me/
-Chrome Extension|[Chrome Web Store](https://chrome.google.com/webstore/detail/pin2me/hclokpdkmfceobbckckjkdohdgeljlld)
-Firefox Extension|[Firefox Add-On](https://addons.mozilla.org/en-US/firefox/addon/pin2me/)
+| Platform          | Link                                                                                               |
+| ----------------- | -------------------------------------------------------------------------------------------------- |
+| Web               | https://pin2me.dev/                                                                                |
+| Demo              | https://demo.pin2me.dev/                                                                |
+| Chrome Extension  | [Chrome Web Store](https://chrome.google.com/webstore/detail/pin2me/hclokpdkmfceobbckckjkdohdgeljlld) |
+| Firefox Extension | [Firefox Add-On](https://addons.mozilla.org/en-US/firefox/addon/pin2me/)                              |
 
 ### Usage
 
@@ -61,7 +63,9 @@ Google Login(optional) enable following
   - For browsers/devices don't support add-on/extension
 
 #### Import/Export
+
 ##### Support
+
 - Apply setting from editor box
 - Copy to clipboard
 - Save to file (Pin2Me.json)
@@ -70,40 +74,46 @@ Google Login(optional) enable following
   - No upload to other server. This is the same when using https://pin2me.dev/ .
 
 ##### Access
+
 1. Click 3-dot icon on upper right to expand menu items
 2. Click setting icon
 3. Click 'Advance' in pop-up dialog
 4. Click 'Import/Export' button
 
 ##### Import
+
 1. Open Pin2Me.json with text editor
 2. Copy and paste content into Import/Export editor box
 3. Click 'Apply'.
 
 #### Preset Sites
 
 Pin2Me comes with a few preset sites. Their URLs and names cannot be change, but can moved and removed. To remove them:
+
 ##### Remove One by One
+
 - Double click to open site setting
 - Click 'Delete'
+
 ##### Remove All
+
 1. Click 3-dot icon on upper right to expand menu items
 2. Click setting icon
 3. Click 'Advance' in pop-up dialog
 4. Click 'Remove Default Sites'
 
 ### Planned
+
 - Drag & Drop for import
 - More platforms
 - Extension support web page context menu
 
 ### Build
 
-Platform|File
----|---
-Chrome Extension|[doc/BUILD.ext.chrome.md](doc/BUILD.ext.chrome.md)
-Firefox Extension|[doc/BUILD.ext.moz.md](doc/BUILD.ext.moz.md)
-Web|[doc/BUILD.web.md](doc/BUILD.web.md)
+| Platform                 | File                                            |
+| ------------------------ | ----------------------------------------------- |
+| Chrome/Firefox Extension | [doc/BUILD.ext.md](doc/BUILD.ext.md) |
+| Web                      | [doc/BUILD.web.md](doc/BUILD.web.md)               |
 
 ### Repository
 
@@ -114,6 +124,7 @@ git clone https://github.com/J-Siu/pin2me
 ```
 
 ### Known Issue
+
 - Firefox
   - #2 Extension showing a extension url in address bar
   - Add-on not activate on first tab
@@ -125,22 +136,23 @@ git clone https://github.com/J-Siu/pin2me
 ### Change Log
 
 - [CHANGELOG.md](CHANGELOG.md)
+
 ### Library
 
-Library|Source|Pub.Dev
----|---|---
-json_preferences|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/json_preferences
-lazy_cache|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_cache
-lazy_collection|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_collection
-lazy_g_drive|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_g_srive
-lazy_g_sync|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_g_sync
-lazy_log|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_log
-lazy_sign_in|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_sign_in
-lazy_sign_in_extension|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_sign_in_extension
-lazy_sign_in_google|https://github.com/J-Siu/flutter_lazy|https://pub.dev/packages/lazy_sign_in_google
-provider|https://github.com/rrousselGit/provider|https://pub.dev/packages/provider
-reorderables|https://github.com/hanshengchiu/reorderables|https://pub.dev/packages/reorderables
-theme_provider|https://www.github.com/kdsuneraavinash/theme_provider|https://pub.dev/packages/theme_provider
+| Library                | Source                                                | Pub.Dev                                         |
+| ---------------------- | ----------------------------------------------------- | ----------------------------------------------- |
+| json_preferences       | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/json_preferences       |
+| lazy_cache             | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_cache             |
+| lazy_collection        | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_collection        |
+| lazy_g_drive           | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_g_srive           |
+| lazy_g_sync            | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_g_sync            |
+| lazy_log               | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_log               |
+| lazy_sign_in           | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_sign_in           |
+| lazy_sign_in_extension | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_sign_in_extension |
+| lazy_sign_in_google    | https://github.com/J-Siu/flutter_lazy                 | https://pub.dev/packages/lazy_sign_in_google    |
+| provider               | https://github.com/rrousselGit/provider               | https://pub.dev/packages/provider               |
+| reorderables           | https://github.com/hanshengchiu/reorderables          | https://pub.dev/packages/reorderables           |
+| theme_provider         | https://www.github.com/kdsuneraavinash/theme_provider | https://pub.dev/packages/theme_provider         |
 
 ### License
 

diff --git a/doc/BUILD.ext.chrome.md b/doc/BUILD.ext.chrome.md
diff --git a/doc/BUILD.ext.md b/doc/BUILD.ext.md
@@ -0,0 +1,105 @@
+<!-- TOC -->
+
+- [Flutter](#flutter)
+- [Build Scripts](#build-scripts)
+- [Build](#build)
+- [Testing Chrome Extension](#testing-chrome-extension)
+- [Testing Firefox Extension](#testing-firefox-extension)
+- [Zip Files for Submission](#zip-files-for-submission)
+
+<!-- /TOC -->
+
+### Flutter
+
+Pin2Me is developed in Dart/Flutter.
+
+Install Flutter: https://docs.flutter.dev/get-started/install
+
+### Build Scripts
+
+Build scripts are written in bash and only work in Linux/MaxOS.
+
+Why?
+- Due to difference between web, Chrome extension and Firefox extension.
+- Switch `pubspec.yaml`, `index.html`, `manifest.json` and `api.dart` according to target.
+- Put compiled target into separate directories
+
+### Build
+
+> Compiled extension are html/javascript only, no web assembly(removed by build script).
+
+Go into source root(`pin2me`):
+
+```sh
+cd pin2me
+```
+
+To compile Chrome extension:
+
+```sh
+bash scripts/buildExtChrome.sh
+bash scripts/buildExtChromeTest.sh
+```
+
+> `buildExtChrome.sh` also creates zip file for submission from release target.
+
+To compile Firefox extension:
+
+```sh
+bash scripts/buildExtMoz.sh
+bash scripts/buildExtMozTest.sh
+```
+
+> `buildExtMoz.sh` also creates zip file for submission from release target.
+
+Target location:
+
+Platform|Mode|Path|Javascript Minified
+---|---|---|---
+Chrome|Release|`~/Downloads/pin2me/ext.chrome`|yes
+Chrome|Profile/Test|`~/Downloads/pin2me/ext.chrome.test`|no
+Firefox|Release|`~/Downloads/pin2me/ext.moz`|yes
+Firefox|Profile/Test|`~/Downloads/pin2me/ext.moz.test`|no
+
+### Testing Chrome Extension
+
+In Chrome, enable develope mode in `Extensions` window, then use `Load unpacked`.
+
+### Testing Firefox Extension
+
+PS: First tab will be empty or Firefox default page. Open 2nd tab to activate addon. It is known issue on Firefox for this addon.
+
+Testing release version:
+```sh
+cd ~/Downloads/pin2me/ext.moz
+web-ext run
+```
+
+Testing profile/test version:
+```sh
+cd ~/Downloads/pin2me/ext.moz.test
+web-ext run
+```
+
+### Zip Files for Submission
+
+Zip File Source|Zip File Path
+---|---
+`~/Downloads/pin2me/ext.chrome`|`~/Downloads/pin2me/ext.chrome.zip`
+`~/Downloads/pin2me/ext.moz`|`~/Downloads/pin2me/ext.moz.zip`
+
+Create Chrome extension zip manually:
+
+```sh
+cd ~/Downloads/pin2me/ext.chrome
+zip -r ../ext.chrome.zip *
+cd ..
+```
+
+Create Firefox extension zip manually:
+
+```sh
+cd ~/Downloads/pin2me/ext.moz
+zip -r ../ext.moz.zip *
+cd ..
+```