MTGJSON Documentation Application

Getting Started

Installation

Install node, n, and yarn.

Option #1 (Preferred): Install Node with brew.

brew install n yarn
sudo n 12.8.0

Option #2: Install Node using the official resource installer.

Install global dependencies. (Optional. May need admin rights.)

yarn boostrap

Install project dependencies.

yarn install

Developing

Runs the local build server with hot module reloading.

yarn dev

Linting

Lint's the files for any breaking changes.

yarn lint

Testing

Tests project using Jest tests and attempts to run a build. This command will also automatically run during Husky's pre-commit checks.

yarn test

Building

Build out the entire site as a static project.

yarn build

Purging

Clean out all Node packages.

yarn purge

Notes

Landcycle, what is it?

Landcycle is a JS class that allows JSON to take mustache variables such as {{link@anchor-link-test@/anchor-link-href}} (use / to make an internal link and use the HTTP/S Protocol for an external link) and {{code@variable}} (creating an inline-code style) and then intercepts the JSON in Vue to hydrate the data in to HTML of your choosing. On the website we mainly use this to change data links in to anchor tags that route to other documentation links to maintain our Single Page Application.