argus-ui v0.22.1

ARGUS BASE HMI

Built using React/Mobx/Webpack

Contents

• Development Environment
• Build for deployment
• Recommendations
• Other

Build

• Run npm build
• Follow instructions in console for deployment

Development Environment

The accent marks (`) in the steps below are for readability in VSCode, do not use these when running commands

• Install TortoiseGit
  • To fix line ending errors in VSCode, run git config --global core.autocrlf false
• Get access to the BitBucket repo
• Checkout the repo:
  • Replace username with your user ID
  • Replace workspace with the directory you want your branch in
  • When prompted, use windows credentials for the password
• Install VSCode
• Install NodeNPM
• Reboot PC
• Delete node_modules folder if present
• Delete package-lock.json
• Run npm cache clean --force
• Run npm install -- may take some time the first install, you only need to do this the first time you checkout or install a new package
• Enter command export NODE_OPTIONS=--openssl-legacy-provider

Run

• Run npm start
• Locally hosted UI should open in your browser automagically
• Updates to files should recompile and update live in the browser, also automagically

Run Tests

• Run npm run test:nowatch

Recommendations

Editor

• VS Code

Plugins Recommended

• Auto Close Tag
• Auto Rename Tag
• ESLint
• Prettier
• sort-imports (blue arrow icon)
• npm
• Sass
• Typescript Hero
• vscode-styled-components
• Simple React Snippets
• Path Autocomplete
• Log File Highlighter
• IntelliSense for CSS class names in HTML
• Document This

Other