Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.35 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.35 KB

ARCH Web Components

This directory contains the source code for ARCH's frontend Typescript / Lit -based web components.

Building the Components

Prerequisites

  • GNU Make
  • node (tested with v16.14.2)
  • npm (tested with v8.5.0)

We recommend using nvm (node version manager) to install and manage your node/npm versions: Installing and Updating

Install the Dependencies

Using a terminal, in this directory (i.e. .../webapp/src), execute:

npm install

Run eslint to check for coding errors

make lint

Correct or explicitly ignore any identified warnings and errors.

Run prettier to automatically format the code

make format

Whether or not each file complies with prettier's notion of correctness will be printed to the console.

Build the components and update the templates

make bundle

The built components will be written to the ../js/dist/ directory as <some-hash>.js and the templates in .../webapp/WEB-INF will be updated to reflect any new filenames.