Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

49 lines (29 loc) · 1.48 KB
Raw

Contribution Guide

How to start development

Setup

  1. Install Nix package manager
  2. Run nix develop or nix develop --command 'zsh' or direnv allow (if you have direnv)
  3. You can use development tools
$ npm install
$ dprint check

If you use vscode, installing elm-test, elm-format and elm-review into global might make better experience. (Currently not installing them with Nix)

npm run dev

Runs the app in the development mode. Open http://localhost:5173/ to view it in your browser.

The page will reload when you make changes.

NOTE: This project is developed by elm, however this hot reloading uses vite for now.

npm run check

Run linters, formatters, and tests. You can dig further detail in task scripts.
Especially recommend to visit the section about elm-test for the test runner.

npm run build

Builds the app for production to the dist folder.

CSS naming convention

rscss

Deployment

main branch and PRs will be deployed to firebase with GitHub Actions

Cat meow as the bell

🐱

The original uploader was Dcrosby at English Wikipedia., CC BY-SA 3.0, via Wikimedia Commons