The web UI for chpl
Git, Node.js, and Yarn are required to install and run this project.
Clone the repository using git:
See installation instructions here: nodejs but be aware that the required version of Node is 14.x
The project uses Yarn 2+. Installation instructions for Yarn 2+ are not easily found, but some information can be found at: yarn 1 and yarn 2+. The basic steps are to install yarn 1 globally, then run yarn install in the project directory. Yarn 1 can be installed globally with npm: npm install -g yarn
yarn install
yarn build: Build deployable artifactsyarn start: Run a local dev server at: http://localhost:3000/ with automatic reloadingyarn start:dev: Run a local dev server at: http://localhost:3000/ with automatic reloading, but connecting to the DEV environment for datayarn start:prod: Run a local dev server at: http://localhost:3000/ with automatic reloading, but using the production settings for js minification / packaging / etc.yarn start:prod:dev: Run a local dev server at: http://localhost:3000/ with automatic reloading, but using the production settings for js minification / packaging / etc. and connecting to the DEV environment for datalint: Run ESLint against all JavaScript files in the projectlint:fix: Run ESLint against all JavaScript files in the project and fix any errors that ESLint can fix automatically. Especially useful when run asyarn lint:fix src/app/path/to/file.js[x]to automatically apply fixes against a single file
Usable on yarn build and yarn start, these parameters control configuration of some properties
--env.NODE_ENV=productionor--env.NODE_ENV=developmentto indicate whether to build for development or production environments. Defaults todevelopmentif not provided
On most Yarn commands the CSS Linter, JS Linter and HTML Linters will run. Webpack may fail to compile if any of the linters report issues, depending on the severity of the issue.