/viewer

Web UI for the π-Base

Primary LanguageTypeScriptMIT LicenseMIT

🛑 DEPRECATED 🛑

➡️ This package is now managed in the pi-base/web monorepo

build-test codecov viewer Netlify Status

π-Base

The development instance of the π-Base is available at topology-development.pi-base.org.

Architecture

The site is powered by a few different projects, all under github.com/pi-base.

  • core - typescript package containing the shared data model (spaces, properties, formulae, &c.). Available on NPM.
  • compile - typescript package using @pi-base/core to compile a repository of markdown files into a JSON bundle for the viewer to view. Used in a Github action in the data repo. Also available on NPM.
  • data - repo containing all actual mathematical content. Once a PR here has been approved and merged, it triggers a compiler run, which pushes the compiled bundle to S3 for the public viewer to fetch.
  • viewer - this package. Fetches and presents the compiled bundle.

Development

Clone the repo and run

$ pnpm install
$ pnpm start

The developer panel (at /dev) has some utilities that may be helpful for controlling where the data bundle is fetched from, or for interacting with the stored data. By default, the current production data bundle will be used. You may also want to clone the data repo and run a compiler locally to view edits as you make them; see the compiler's README for more details.

Deployment

Deployment is automatic on a successful push to master. See .github/actions and package.json for details.