mtgjson/mtgjson-website

# MTGJSON Documentation Application

[![Actions Status](https://github.com/mtgjson/mtgjson-website/workflows/Node%20CI/badge.svg)](https://github.com/mtgjson/mtgjson-website/actions) ![CodeQL](https://github.com/mtgjson/mtgjson-website/workflows/CodeQL/badge.svg) [![codecov](https://codecov.io/gh/mtgjson/mtgjson-website/branch/main/graph/badge.svg)](https://codecov.io/gh/mtgjson/mtgjson-website) [![PayPal](https://img.shields.io/static/v1.svg?label=PayPal&message=Support%20MTGJSON&color=Blue&logo=paypal)](https://paypal.me/zachhalpern) [![Patreon](https://img.shields.io/static/v1.svg?label=Patreon&message=Support%20MTGJSON&color=Orange&logo=patreon)](https://patreon.com/mtgjson) [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/mtgjson/mtgjson-website/blob/master/LICENSE)

Getting Started

Installation

Install Node with brew:

brew install n
sudo n 18

Developing

Runs the local build server with hot module reloading and eslint watcher.

npm run dev

Linting

Manually lint the files for any breaking changes.

npm run lint

Testing

Run all tests.

npm run test

Run all tests and a test build.

npm run test:full

Building

Build out the entire site as a static project.

Note: This is done via the GitHub Action and pushed to a Release Tag so no need to do this unless you are testing the actual build. Additionally, when submitting a PR, Netlify will deploy an environment for you to test your Pull Request.

npm run build

Purging

Clean out all Node packages and Vitepress cache.

npm run purge

You can also just purge the Vitepress cache with the following.

npm run purge:cache