Git Product home page Git Product logo

viewer's Introduction

🛑 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.