You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<img alt="Packrat by OPFN" src="src/assets/brand/packrat-lockup-color-dynamic.svg" width="90%">
4
4
</div>
5
5
</h1>
6
6
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.
8
8
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.
16
10
17
11
## Architecture
18
12
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.
20
14
21
15
## Development
22
16
23
-
The Chromium extension and Electron app are built from the same source code for ease of development.
24
-
25
17
### Prerequisites
26
18
27
19
- Node >=12
@@ -31,73 +23,25 @@ The Chromium extension and Electron app are built from the same source code for
31
23
32
24
To build the extension or Electron app locally for development, do the following:
1. Clone this repo and `cd` to the working directory
27
+
2. Install dependencies:
43
28
```sh
44
29
yarn install
45
30
```
46
-
4. Make development build:
31
+
3. Create a development build:
47
32
```sh
48
33
yarn build-dev
49
34
```
35
+
OR
36
+
Run `yarn start-ext` to update the build automatically as you make changes
50
37
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
54
39
55
40
To install the extension locally, load the development build as an unpacked extension:
56
41
57
42
1. Open the Chrome Extensions page ([chrome://extensions](chrome://extensions)).
58
43
59
44
2. Choose 'Load Unpacked Extension' and point to the `./dist/ext` directory in your local copy of this repo.
60
45
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.
0 commit comments