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
### Changes
- Updates in-app logos
- Updates extension icon and dev icon
- Adds checkmark to the idle state to better convey the status
- Updates readme with new logo
- Updates Readme text
- Moves app assets to `/src/assets` to match ReplayWebpage & Browsertrix
project file structure
- App icons are still located in `/build` and `/src/static`
- The electron app icons are updated in #226 instead of this PR! Go
check that one out for those!
- Removes old unused brand assets
---------
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
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.
4
8
5
-
ArchiveWeb.page is a JavaScript based system for high-fidelity web archiving directly in the browser.
6
-
The system can be used as a Chrome/Chromium based browser extension and also as an Electron app.
9
+
The system creates, stores, and replays high-fidelity web archives stored directly in the browser's storage (via IndexedDB).
7
10
8
-
The system creates, stores and replays high-fidelity web archives stored directly in the browser (via IndexedDB).
11
+
For more detailed info on how to use the extension and standalone app, see the [ArchiveWeb.page User Guide](https://archiveweb.page/guide).
9
12
10
-
For more detailed info on how to use the extension (and the app when it is available), see the: [ArchiveWeb.page User Guide](https://archiveweb.page/guide)
13
+
The browser extension is available on the[Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd).
11
14
12
-
The initial app release is available on the [Releases page](https://github.com/webrecorder/archiveweb.page/releases)
15
+
Downloads for the desktop are are available on the [GitHub Releases page](https://github.com/webrecorder/archiveweb.page/releases).
13
16
14
-
###Architecture
17
+
## Architecture
15
18
16
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/ikreymer/wabac.js) service worker system for replay and storage.
17
20
18
-
The codebase for the extension and Electron app is shared, but they can be deployed in different ways.
21
+
The codebase for the extension and Electron app is shared, but they can both be deployed in different ways.
19
22
23
+
## Building for Development
20
24
21
-
### Requirements Building
25
+
To develop ArchiveWeb.page, install Node 12+ and Yarn.
22
26
23
-
To develop ArchiveWeb.page, Node 12+ and Yarn are needed.
27
+
### Install the Development Extension
24
28
25
-
## Using the Extension
26
-
27
-
The production version of the extension is published to the [Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd)
28
-
29
-
For development, the extension can be built locally and loaded as an unpacked extension.
30
-
If you want to make changes to the extension, it should be installed in this way.
29
+
For development, the extension can be built locally and loaded as an unpacked extension. If you want to make changes to the extension, do the following:
31
30
32
31
1. Clone this repo. Run `yarn install; yarn build-dev`. (You can also run `yarn build` to build the production version but it may be harder to debug).
33
32
34
-
3. Open the Chrome Extensions page (chrome://extensions).
33
+
3. Open the Chrome Extensions page ([chrome://extensions](chrome://extensions)).
35
34
36
35
4. Choose 'Load Unpacked Extension' and point to the `./dist/ext` directory in your local copy of this repo.
37
36
38
37
5. Click the extension icon to show the extension popup, start archiving, etc...
39
38
40
-
### Development Workflow
39
+
### Development Workflow (Extension)
41
40
42
41
For development, it is recommended to use the dev build of the extension:
43
42
@@ -49,10 +48,7 @@ For development, it is recommended to use the dev build of the extension:
49
48
50
49
4. Click the extension icon to show the extension popup, start recording, etc... The dev build of the extension will be grey to differntiate from the production version.
51
50
52
-
53
-
## Using the Electron App (in beta)
54
-
55
-
The Electron app version is in beta and the latest release can be downloaded from the [Releases page](https://github.com/webrecorder/archiveweb.page/releases)
51
+
### Using the Electron App
56
52
57
53
To run the Electron app development build:
58
54
@@ -63,18 +59,15 @@ To run the Electron app development build:
63
59
3. Run ``yarn run start-electron`` to start the app.
64
60
65
61
The Electron App version will open recording in a new window. It is is designed to support Flash, better support for IPFS sharing.
66
-
However, it is still in development and may not work yet until the initial release is out.
67
-
68
62
69
-
### Development workflow
63
+
### Development workflow (Electron App)
70
64
71
65
After making changes, rerun ``yarn run build-dev`` and ``yarn run start-electron`` to load the app.
72
66
73
-
###Standalone Build
67
+
## Standalone Build
74
68
75
69
To create a platform-specific binary, run:
76
70
77
71
``yarn run pack``
78
72
79
73
The standalone app will then be available in the `./dist/` directory.
0 commit comments