gram: card

> ./README.md

Lenses
(coming soon!)

# Wildcard

> (Re)Based on [original research](https://github.com/geoffreylitt/wildcard) by [@geoffrylitt](https://geoffrylitt.com).

Wildcard is a platform that empowers anyone to build browser extensions and modify websites to meet their own specific needs.

Wildcard shows a simplified view of the data in a web page as a familiar table view. People can directly manipulate the table to sort/filter content, add annotations, and even use spreadsheet-style formulas to pull in data from other websites.

* [Documentation](https://geoffreylitt.github.io/wildcard)
* [Project homepage](https://www.geoffreylitt.com/wildcard/)
* [Research paper](https://www.geoffreylitt.com/wildcard/salon2020/) presented at the Convivial Computing Salon 2020

## Install Wildcard

Be aware: Wildcard is still pre-release software.

**The current master branch is stable, but missing a few important features
that have yet to be ported over from previous versions of the codebase: mainly filtering the table and formulas.**

To get an email when a full featured version is ready, [sign up for the email newsletter](https://tinyletter.com/wildcard-extension).

If you want to install Wildcard today, there are two options:

To use Wildcard with an existing library of supported websites, follow the [quick start instructions](https://geoffreylitt.github.io/wildcard/#/quickstart).

- - -

## Run locally

In my normal commands, I rely on my [nushell helper `nd`][nix.nu], so `web-ext run` becomes `nd web-ext run`. On a normal machine, such a command reads as: `nix develop --command 'web-ext run'`. These prefixes are simply assurance that all the dependencies are in place, so I'll assume you can manage dependencies on your machine and ignore the prefixes here.

I am using the `flake.nix` to manage [nodejs], [yarn], and [web-ext].

```
yarn install
node build.js # many errors! no problem, ignore all.
web-ext run -u news.ycombinator.com
```

[nodejs]: https://nodejs.org/en
[yarn]: https://classic.yarnpkg.com/en/docs/install#debian-stable
[web-ext]: https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/