https://github.com/webrecorder/create-archive-now
https://github.com/webrecorder/create-archive-now
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/webrecorder/create-archive-now
- Owner: webrecorder
- License: agpl-3.0
- Created: 2024-10-12T02:55:16.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T05:00:35.000Z (5 months ago)
- Last Synced: 2025-04-01T10:31:09.127Z (29 days ago)
- Language: TypeScript
- Homepage: https://create.webrecorder.net
- Size: 9.57 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Webrecorder CAN! (Create Archive Now!)
This tool provides a demo of in-browser archiving + replay via a CORS proxy.
It uses the new ArchiveWeb.page embed to provide the archiving,
and `` to provide the replay. Archived data can be expored as a WACZ
file, or cleared when the page is closed.
It requires the ArchiveWeb.page 0.13.0+ and a CORS proxy.
Since it uses a CORS proxy, the capabilities are more limited than through a direct-browser
based archiving via [ArchiveWeb.page](https://webrecorder.net/archiveweb.page).
Nevetheless, this tool serves as a demo of the archiving capabilities of Webrecorder tools.
## Development
### Prerequisites
- Node >=20
- Yarn Classic (v1)
### Installation
Get dependencies:
```sh
yarn
```
Start dev server:
```sh
yarn start
```
### CORS Proxy
Using this service requires a CORS proxy.
We recommend running your own version of a CORS proxy, or our version of: https://github.com/webrecorder/wabac-cors-proxy
which is designed to be run as a Cloudflare Worker. See that repo for configuring allowed origins.
### Using with local AWP
This repo works with the latest release of ArchiveWeb.page NPM package, [@webrecorder/archivewebpage](https://npmjs.com/package/@webrecorder/archivewebpage).
For development, it may be useful to test with a local version of AWP, which does all the archiving / replay.
1) Ensure that you have a locally checked out version of [webrecorder/archiveweb.page](https://github.com/webrecorder/archiveweb.page) built. Run `yarn run build` in that repo.
2) Run `yarn link "@webrecorder/archivewebpage"` in this repo
3) Run `yarn run update-awp` to copy the built dist files from AWP for testing.
4) Run `yarn start`.