@internetarchive/collection-browser

Internet Archive Collection Browser

This is the main collection browser for the Internet Archive website.

Review app URL

Usage

import '@internetarchive/collection-browser';

<collection-browser>
</collection-browser>

Local Demo with web-dev-server

yarn install
yarn start

To run a local development server that serves the basic demo located in index.html

Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

yarn run test

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

yarn run test:watch

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

yarn run lint

You can lint with ESLint and Prettier individually as well

yarn run lint:eslint

yarn run lint:prettier

To automatically fix many linting errors, run

yarn run format

You can format using ESLint and Prettier individually as well

yarn run format:eslint

yarn run format:prettier

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Manual Deploy using gh-pages

Live demo app from current main branch: https://internetarchive.github.io/iaux-collection-browser

yarn run deploy

Automatic Deploy of Demo App

When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.

This URL will be removed when the Pull Request is merged/closed.

Example: https://internetarchive.github.io/iaux-collection-browser/pr/<pr-number>