Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update App Branding #227

Merged
merged 18 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 21 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
# ArchiveWeb.page Interactive Archiving Extension and Desktop App
<h1>
<div align="center">
<img alt="ArchiveWebpage" src="src/assets/brand/archivewebpage-lockup-color-dynamic.svg" width="90%">
</div>
</h1>

<p align="center"><img src="/assets/awp-logo.svg" width="96" height="96"></p>
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.

ArchiveWeb.page is a JavaScript based system for high-fidelity web archiving directly in the browser.
The system can be used as a Chrome/Chromium based browser extension and also as an Electron app.
The system creates, stores, and replays high-fidelity web archives stored directly in the browser's storage (via IndexedDB).

The system creates, stores and replays high-fidelity web archives stored directly in the browser (via IndexedDB).
For more detailed info on how to use the extension and standalone app, see the [ArchiveWeb.page User Guide](https://archiveweb.page/guide).

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)
The browser extension is available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd).

The initial app release is available on the [Releases page](https://github.com/webrecorder/archiveweb.page/releases)
Downloads for the desktop are are available on the [GitHub Releases page](https://github.com/webrecorder/archiveweb.page/releases).

### Architecture
## Architecture

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.

The codebase for the extension and Electron app is shared, but they can be deployed in different ways.
The codebase for the extension and Electron app is shared, but they can both be deployed in different ways.

## Building for Development

### Requirements Building
To develop ArchiveWeb.page, install Node 12+ and Yarn.

To develop ArchiveWeb.page, Node 12+ and Yarn are needed.
### Install the Development Extension

## Using the Extension

The production version of the extension is published to the [Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd)

For development, the extension can be built locally and loaded as an unpacked extension.
If you want to make changes to the extension, it should be installed in this way.
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:

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).

3. Open the Chrome Extensions page (chrome://extensions).
3. Open the Chrome Extensions page ([chrome://extensions](chrome://extensions)).

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

5. Click the extension icon to show the extension popup, start archiving, etc...

### Development Workflow
### Development Workflow (Extension)

For development, it is recommended to use the dev build of the extension:

Expand All @@ -49,10 +48,7 @@ For development, it is recommended to use the dev build of the extension:

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.


## Using the Electron App (in beta)

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)
### Using the Electron App

To run the Electron app development build:

Expand All @@ -63,18 +59,15 @@ To run the Electron app development build:
3. Run ``yarn run start-electron`` to start the app.

The Electron App version will open recording in a new window. It is is designed to support Flash, better support for IPFS sharing.
However, it is still in development and may not work yet until the initial release is out.


### Development workflow
### Development workflow (Electron App)

After making changes, rerun ``yarn run build-dev`` and ``yarn run start-electron`` to load the app.

### Standalone Build
## Standalone Build

To create a platform-specific binary, run:

``yarn run pack``

The standalone app will then be available in the `./dist/` directory.

85 changes: 0 additions & 85 deletions assets/awp-logo.svg

This file was deleted.

29 changes: 0 additions & 29 deletions assets/btrix-cloud.svg

This file was deleted.

Loading
Loading