3968928ac2
## Overview Adds a bunch of ESLint rules, mostly from `typescript-eslint`, and fixes the issues turning on these rules raises. Also updates Typescript & typescript-eslint. ## Rationale Most of these new rules are auto-fixable, so I've tackled a bunch of the little fixes that do need manual intervention now with the intention that this shouldn't add much of any additional friction in future development work, and also give us a good bump in overall code quality. A lot of the rules here are also great for catching potential bugs! ## Changes - Adds `void` to most un-awaited and unhandled promises (i.e. places where async functions are called but nothing is done with the promise) - Converts properties that are only ever read to `readonly` - Adds a new `isApiError` function that informs Typescript of when an error is an `APIError` - Adds types to a bunch of places that were previously untyped - Changes instances of `Map<string, any>` in lit property update methods to `PropertyValues<this>`, or sometimes `PropertyValues<this> & Map<string, unknown>` where private or protected members are used (`keyof` doesn't include private and protected members, unfortunately) - Adds types to a bunch of custom events - Cleans up a regex by removing unnecessary escape characters - Makes a number of implied type conversions explicit (by wrapping with `Boolean(...)` or calling `.toString()`) - More consistently applies type coercions when necessary, and removes them when unnecessary - Converts a couple const strings to an enum - Removes the need to type debounced functions as `any` by doing type coercions to the underlying function type at where the method is bound to the event in the `html` block |
||
|---|---|---|
| .github | ||
| .vscode | ||
| ansible | ||
| backend | ||
| chart | ||
| configs | ||
| docs | ||
| frontend | ||
| scripts | ||
| test | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| btrix | ||
| CHANGES.md | ||
| LICENSE | ||
| mkdocs.yml | ||
| NOTICE | ||
| pylintrc | ||
| README.md | ||
| update-version.sh | ||
| version.txt | ||
| yarn.lock | ||
Browsertrix Cloud
Browsertrix Cloud is an open-source cloud-native high-fidelity browser-based crawling service designed to make web archiving easier and more accessible for everyone.
The service provides an API and UI for scheduling crawls and viewing results, and managing all aspects of crawling process. This system provides the orchestration and management around crawling, while the actual crawling is performed using Browsertrix Crawler containers, which are launched for each crawl.
See Browsertrix Cloud for a feature overview and information about Browsertrix Cloud Hosting.
Documentation
The full docs for using, deploying and developing Browsertrix Cloud are available at: https://docs.browsertrix.cloud
Deployment
The latest deployment documentation is available at: https://docs.browsertrix.cloud/deploy
The docs cover deploying Browsertrix Cloud in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.
Previously, Browsertrix Cloud also supported Docker Compose and podman-based deployment. This is now deprecated due to the complexity of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine.
Making deployment of Browsertrix Cloud as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options.
If you are looking to just try running a single crawl, you may want to try Browsertrix Crawler first to test out the crawling capabilities.
Development Status
Browsertrix Cloud is currently in a beta, though the system and backend API is fairly stable, we are working on many additional features.
Additional developer documentation is available at https://docs.browsertrix.cloud/develop
Please see the GitHub issues and this GitHub Project for our current project plan and tasks.
License
Browsertrix Cloud is made available under the AGPLv3 License.
Documentation is made available under the Creative Commons Attribution 4.0 International License