CONTRIBUTING.md

Contributing

What's in Standard? has three code bases, all in this repository.

• API and website (see below)
• Mobile apps (see ./mobile)
• Autotweeter (see ./firebase)

API and website

The website is a Vue JavaScript app that consumes the API. They are served by the same server.

The API is powered by the raw data in api/internal.json, which is converted into the various API formats at build time by api/generate.js.

Dependencies

• Node.js

Running locally

git clone [email protected]:glacials/whatsinstandard
cd whatsinstandard/web
npm install
npm start

Then open the printed local URL in your browser.

Common tasks

Updating sets

If you're looking to add, remove, or edit a set, you'll want to change api/internal.json then run

npm prepare

to regenerate each API version. This file is the source of truth for set information, even for the website itself.

Editing the page

To change the layout of the page, use

Running tests

The API has a few tests. They run on build, but you can run them separately with

npm test

To autorun them whenever test files update, use

npm run autotest

Adding new set icons

Set icon SVGs are supplied by Keyrune. When new icons are published, a bot should open a pull request automatically. If it doesn't for some reason, you can run

npm update keyrune

and submit a pull request.