nova-scope

Monash Nova Rover's implementation of OpenMCT for accessible monitoring and configuration management of Rover peripheral devices.

Prerequisites

• node.js
  • Mac OS: We recommend using Homebrew to install node.

    $ brew install node
    

  • Windows: https://nodejs.org/en/download/
  • linux: https://nodejs.org/en/download/
  • Raspberry Pi

   sudo apt update
   sudo apt install nodejs npm -y
  

• git
  • Mac OS: If XCode is installed, git is likely to already be available from your command line. If not, git can be installed using Homebrew.

    $ brew install git
    

  • Windows: https://git-scm.com/downloads
  • linux: https://git-scm.com/downloads

Install

git clone https://github.com/ecthelion99/nova-scope.git
cd nova-scope
npm install
npm run build

Start Server

npm start

The server URL will be printed to the console.

Clean Build Artifacts

On Windows

npm run clean-win

On Linux

npm run clean-linux

Directory Structure

├── dist/ # Webpack bundle is written here (this is .gitignored) 
├── docs/ # Documentation and instructions
├── example-server/ # Static server for hosting OpenMCT
├── node_modules/ # Node.js dependencies specified in package.json
├── python-request-listener/ # HTTP server that listens for GET requests
├── scripts/ # Useful shell scripts
├── src/ # Source code for MNR's OpenMCT plugins
├── .gitignore # Ignored files (e.g., dist/)
├── index.html # OpenMCT main entry point
├── package-lock.json # Locks down the exact versions of every installed dependency in Node.js (this is .gitignored) 
├── package.json # Node.js dependencies
├── README.md # Project overview and directory layout
├── system_composition.json # Describes the Rover system to OpenMCT
├── webpack.config.js # Webpack configuration for bundling JavaScript modules