improve typescript and linting usage across codebase
add ts-lit-plugin and eslint-typescript disable no-invalid-css rule fix a bunch of errors raised by eslint and typescript run prettier & eslint on the remaining files remove unused imports split coll-index into index and info components... and rename "coll" -> "item" for these. also includes some fixes for previously-undocumented properties used on non-ts elements. extract labeled fields into separate component... and make a few type improvements too swap custom copy button for shoelace one rename a few more missed things
This commit is contained in:
@@ -3,9 +3,10 @@
|
||||
# ReplayWeb.page
|
||||
|
||||
## Serverless Web Archive Replay
|
||||
|
||||
[Embedded Viewer](https://replayweb.page/docs/embedding) Usage: [](https://www.jsdelivr.com/package/npm/replaywebpage)
|
||||
|
||||
ReplayWeb.page provides a full web archive replay system running directly in the browser,
|
||||
ReplayWeb.page provides a full web archive replay system running directly in the browser,
|
||||
available at: [https://replayweb.page/](https://replayweb.page)
|
||||
|
||||
For full user docs, see: [https://replayweb.page/docs](https://replayweb.page/docs).
|
||||
@@ -18,7 +19,6 @@ The ReplayWeb.page App can be downloaded from the [Releases](https://replayweb.p
|
||||
|
||||
See the [Embedding Guide](https://replayweb.page/docs/embedding) for more info on embedding web archives in other sites.
|
||||
|
||||
|
||||
## What's in this repo
|
||||
|
||||
ReplayWeb.page is a static web site / offline web app + Electron app.
|
||||
@@ -29,6 +29,7 @@ implementation found at: https://github.com/webrecorder/wabac.js
|
||||
The frontend is loaded from `ui.js`, while the backend service/web worker is loaded from `sw.js`.
|
||||
|
||||
This repository contains:
|
||||
|
||||
- The built assets for the site hosted at https://replayweb.page/ via GitHub Pages
|
||||
- The package for npm module: https://www.npmjs.com/package/replaywebpage
|
||||
- A build system for https://replayweb.page and ReplayWeb.page App.
|
||||
@@ -41,7 +42,6 @@ To run ReplayWeb.page and view web archives, a regular HTTP server is all that i
|
||||
|
||||
ReplayWeb.page can run with any HTTP server locally. For example, you can run `http-server -p 9990` or `python -m http.server 9990` to run a static web server in the directory of this repository. Then, simply load `http://localhost:9990/` and you'll have replayweb.page running locally.
|
||||
|
||||
|
||||
## Developing ReplayWeb.page
|
||||
|
||||
ReplayWeb.page is built as a Node package can be installed using yarn:
|
||||
@@ -66,29 +66,20 @@ The package provides various commands that can be used with yarn:
|
||||
|
||||
- `yarn run start-jekyll` - to build Jekyll docs and start Jekyll static server on port 4000.
|
||||
|
||||
|
||||
The static assets are placed in the root `index.html`, `sw.js` and `ui.js`, and can be used with any HTTP server.
|
||||
|
||||
For service workers to work, they must be served from either localhost or an HTTPS endpoint.
|
||||
|
||||
See the [user docs](https://replayweb.page/docs/) for additional info about using ReplayWeb.page
|
||||
|
||||
|
||||
|
||||
## LICENSE
|
||||
|
||||
ReplayWeb.page is made available under the AGPLv3 License.
|
||||
|
||||
If you would like to use it under a different license or have a question, please reach out as that may be a possibility.
|
||||
|
||||
|
||||
## Contributing and Bug Reports
|
||||
|
||||
Contributions are definitely welcome!
|
||||
|
||||
As this is still a new project and rapidly evolving, please open an issue first before submitting a pull request.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user