Skip to content

CONRTIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 1.34 KB

CONRTIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.34 KB

Contributing

Warning

This is purely a testbed for trying out ideas and experimenting with newer APIs and techniques. Consider everything experimental and not recommended for production use.

Getting Started

Prerequisites

  • Git, >= 2.7.2
  • NodeJS, >= v20.11.1
  • Yarn, 4.1.0 (this repository does not commit the cache)

For those using nvm, simply run the following command to install the required version of NodeJS:

nvm use

Dependencies

From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:

yarn install

Developing

Running locally (defaults to http://127.0.0.1:5500)

yarn start

Check and fix code style

yarn lint

Optimize images from assets/media and assets/favicon and saves the optimized versions to assets/media-opt and assets/favicon-opt respectively:

yarn images

Release

Build and bundle files in src to assets/bundle

yarn build

To analyze the bundle

yarn analyze

The built files from assets/* plus index.html can be served from any static file server. GitHub Pages are used for this repository and deployed to https://d13.github.io/.