CONTRIBUTING.md

Getting started

Remote development

Gitpod lets you get started coding without the need to install any extra programs on your computer:

Local development

Requirements:

• Node.js v18+

Steps:

1. git clone
2. npm install
3. npm start
4. Open the web app at http://localhost:3000

Visual Studio Code extensions

If you use Visual Studio Code, it's recommended to install these extensions for the best experience.

You can find this list by opening the Command Palette and choosing "Extensions: Show Recommended Extensions"

• EditorConfig for VS Code
• ESLint
• Flow Language Support
• Prettier - Code formatter

Libraries

This project is primarily a React app.

It's highly recommended to install the React Developer Tools on your browser for easier debugging.

Code style

Use Prettier.

If you have the proper VSCode setup, then it should be auto-formatted on save, no need to worry about code style!

Otherwise, run npm run prettier -- --write to auto-fix.

Type-checking

This project uses Flow for static type-checking, similar to TypeScript. Flow is used due to the original author being familiar with it for many years (well, many of the decisions in this project are due to that...)

Run npm run flow to see errors.

Linting

This project uses ESLint for linting.

Run npm run lint to see errors.

Running tests

This project uses Jest for testing.

Run npm test to run the tests. Some tests may fail on the first attempt due to timeout but re-running them should work.

Code coverage

Code coverage can be obtained by running npm test -- --coverage

Extra notes

This project used to be bootstrapped with Create React App but it's now migrated to Vite, because of this, there are a few quirks that is normally not seen on other Vite projects:

• Jest is used instead of Vitest as canvas in jsdom doesn't work on Vitest
• babel.config.js is only used by Jest