/the-salt-box

Primary LanguageTypeScript

The Salt Box

Informational website for a Magic: The Gathering Cube event in Baltimore.

http://thesaltbox.fun/

Prerequisites

  • Node 18: nvm is recommended for installing and managing Node. After installing, run $ nvm install in this project directory.
  • Yarn to install JavaScript dependencies.

Setup

In the project directory, install dependencies with:

$ yarn install

See the detailed setup instructions for more info and troubleshooting.

Development

Run the development server with:

$ yarn start

View the site in a browser at http://localhost:8000

Validating and Formatting

A few tools are used to enhance and validate JavaScript. It's recommended to install plugins for these in your text editor if available to validate and format automatically.

  • TypeScript is used to type check JavaScript. Run $ yarn types:check to check manually.
  • Prettier formats JavaScript and CSS, enforcing consistency and reducing incidental changes. Run $ yarn format to manually format, or $ yarn format:check to verify.
  • ESLint checks for some kinds of JavaScript errors and consistent style. Run $ yarn lint to manually check.

Updating

After pulling changes, or when switching between branches with different dependencies, update all installed dependencies with:

$ yarn install