Skip to content

Commit 04dc373

Browse files
committed
Merge branch 'main' into nikita-onboarding-flow
2 parents 41914b6 + 7ce00c4 commit 04dc373

18 files changed

Lines changed: 32 additions & 88 deletions

.github/workflows/buildext.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,20 @@ jobs:
3838
- name: Create ZIP for Extension
3939
run: |
4040
cd dist/ext
41-
zip ../../ArchiveWeb.page-${{ steps.package-version.outputs.current-version }}-extension.zip -r ./
41+
zip ../../Packrat-${{ steps.package-version.outputs.current-version }}-extension.zip -r ./
4242
4343
- name: Upload Extension ZIP to GitHub
4444
uses: softprops/action-gh-release@v1
4545
with:
46-
files: ArchiveWeb.page-${{ steps.package-version.outputs.current-version }}-extension.zip
46+
files: Packrat-${{ steps.package-version.outputs.current-version }}-extension.zip
4747
tag_name: v${{ steps.package-version.outputs.current-version }}
4848
fail_on_unmatched_files: true
4949
draft: true
5050

5151
- name: Upload Extension ZIP to Chrome Web Store
5252
uses: mnao305/chrome-extension-upload@3.0.0
5353
with:
54-
file-path: ArchiveWeb.page-${{ steps.package-version.outputs.current-version }}-extension.zip
54+
file-path: Packrat-${{ steps.package-version.outputs.current-version }}-extension.zip
5555
extension-id: fpeoodllldobpkbkabpblcfaogecpndd
5656
client-id: ${{ secrets.CHROME_WEBSTORE_CLIENT_ID }}
5757
client-secret: ${{ secrets.CHROME_WEBSTORE_CLIENT_SECRET }}

README.md

Lines changed: 12 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
11
<h1>
22
<div align="center">
3-
<img alt="ArchiveWebpage" src="src/assets/brand/archivewebpage-lockup-color-dynamic.svg" width="90%">
3+
<img alt="Packrat by OPFN" src="src/assets/brand/packrat-lockup-color-dynamic.svg" width="90%">
44
</div>
55
</h1>
66

7-
ArchiveWeb.page is a JavaScript based application for interactive, high-fidelity web archiving that runs directly in the browser. The system can be used as a Chrome/Chromium based browser extension and also as a standalone Electron app.
7+
Packrat is an browser extension for Chromium-based browsers that lets you create high-fidelity web archives out of your browsing history.
88

9-
The system creates, stores, and replays high-fidelity web archives stored directly in the browser's storage (via IndexedDB).
10-
11-
For more detailed info on how to use the extension and standalone app, see the [ArchiveWeb.page User Guide](https://archiveweb.page/guide).
12-
13-
The browser extension is available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd).
14-
15-
Downloads for the desktop are are available on the [GitHub Releases page](https://github.com/webrecorder/archiveweb.page/releases).
9+
Packrat is available on the Chrome Web Store.
1610

1711
## Architecture
1812

19-
The extension makes use of the Chrome debugging protocol to capture and save network traffic, and extends the [ReplayWeb.page](https://github.com/webrecorder/replayweb.page) UI and the [wabac.js](https://github.com/webrecorder/wabac.js) service worker system for replay and storage.
13+
Packrat is based on Webrecorder's [ArchiveWeb.page](https://webrecorder.net/archivewebpage) which uses the Chrome debugging protocol to capture and save network traffic. Like ArchiveWeb.page, Packrat also uses Webrecorder's [ReplayWeb.page](https://webrecorder.net/replaywebpage) viewer to replay archived content.
2014

2115
## Development
2216

23-
The Chromium extension and Electron app are built from the same source code for ease of development.
24-
2517
### Prerequisites
2618

2719
- Node >=12
@@ -31,73 +23,25 @@ The Chromium extension and Electron app are built from the same source code for
3123

3224
To build the extension or Electron app locally for development, do the following:
3325

34-
1. Clone this repo:
35-
```sh
36-
git clone https://github.com/webrecorder/archiveweb.page.git
37-
```
38-
2. Change the working directory:
39-
```sh
40-
cd archiveweb.page
41-
```
42-
3. Install dependencies:
26+
1. Clone this repo and `cd` to the working directory
27+
2. Install dependencies:
4328
```sh
4429
yarn install
4530
```
46-
4. Make development build:
31+
3. Create a development build:
4732
```sh
4833
yarn build-dev
4934
```
35+
OR
36+
Run `yarn start-ext` to update the build automatically as you make changes
5037

51-
The development build can now be used to develop the extension or Electron app.
52-
53-
### Developing the Chromium extension
38+
### Adding the development extension to Chrome
5439

5540
To install the extension locally, load the development build as an unpacked extension:
5641

5742
1. Open the Chrome Extensions page ([chrome://extensions](chrome://extensions)).
5843

5944
2. Choose 'Load Unpacked Extension' and point to the `./dist/ext` directory in your local copy of this repo.
6045

61-
3. Click the extension icon to show the extension popup, start archiving, etc...
62-
63-
#### Update extension on code changes
64-
65-
To watch source code files and recompile the development build on change, run:
66-
67-
```sh
68-
yarn run start-ext
69-
```
70-
71-
Now, saving changes to source will automatically rebuild the `dist/ext` directory.
72-
73-
After making changes, the extension still needs to be reloaded in the browser.
74-
75-
1. From the Chrome extensions page, click the reload button to load the latest version.
76-
77-
2. Click the extension icon to show the extension popup, start recording, etc... The dev build of the extension will be a different color from the production version.
78-
79-
### Developing the Electron app
80-
81-
To start the Electron app using development build:
82-
83-
```sh
84-
yarn run start-electron
85-
```
86-
87-
The Electron app will open recording in a new window. It is is designed to support Flash, better support for IPFS sharing.
88-
89-
#### Update app on change
90-
91-
Currently, the dev workflow for the Electron app does not support automatically rebuilding on file changes.
92-
93-
After making changes, rerun `yarn run build-dev` and `yarn run start-electron` to view your changes in the app.
94-
95-
## Standalone Build
96-
97-
To create a platform-specific binary, run:
98-
99-
```sh
100-
yarn run pack
101-
```
102-
103-
The standalone app will then be available in the `./dist/` directory.
46+
> [!NOTE]
47+
> You'll still have to refresh the extension from chrome://extensions as you make changes, even if you're using live reloading.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
2-
"name": "@webrecorder/archivewebpage",
3-
"productName": "ArchiveWeb.page",
2+
"name": "@opfn/packrat",
3+
"productName": "Packrat",
44
"version": "0.15.0",
55
"main": "index.js",
6-
"description": "Create Web Archives directly in your browser",
6+
"description": "Create an archive of every page you browse",
77
"repository": {
88
"type": "git",
99
"url": "git+https://github.com/webrecorder/archiveweb.page.git"
1010
},
11-
"author": "Webrecorder Software",
11+
"author": "OPFN",
1212
"license": "AGPL-3.0-or-later",
1313
"dependencies": {
1414
"@fortawesome/fontawesome-free": "^5.13.0",

src/assets/brand/archivewebpage-lockup-color-dynamic.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/assets/brand/archivewebpage-lockup-color.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)