Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.79 KB

README.md

File metadata and controls

43 lines (25 loc) · 1.79 KB

TDT4290 Aqeous

Build Status GitHub release

The project is a part of the course TDT4290 Customer driven project in the autumn of 2019.

During this project, we will build a graphical user interface for controlling a ROV with an Xbox controller built on web technologies (Electron, Node, React). The GUI will incorporate a videofeed, ability to connect to a ROV simulation and use a subset of the IMC protocol for communication.

This project is a continuation of last year group, which can be found here, however rewritten with web technologies.

Prerequisites

We recommend Visual Studio Code as IDE/text editor.

Windows

We recommend Git Bash, which can be downloaded here, as shell/command promt.

You also need to download these if you haven't already.

  1. node
  2. yarn

MacOS

We recommend the package manager Homebrew for downloadning packages as well as keeping track of dependencies. When you have that installed, all you need to do is to run

brew install yarn

How to run locally

Run these command from your shell/terminal:

yarn # installs all dependencies
yarn electron-dev

Contributing

Follow the conventions specified in CONTRIBUTION.