Skip to content

MTGJSON Documentation Front-End Application built with VitePress

License

Notifications You must be signed in to change notification settings

mtgjson/mtgjson-website

Repository files navigation

MTGJSON Documentation Application



Actions Status CodeQL codecov

PayPal Patreon

MIT license

Getting Started

Installation

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

brew install n
sudo n 12

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

Install project dependencies.

npm install

Developing

Runs the local build server with hot module reloading.

npm run dev

Linting

Lint's the files for any breaking changes.

npm run 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.

npm run test

Building

Build out the entire site as a static project.

npm run build

Purging

Clean out all Node packages.

npm run purge