Skip to content

Installation tests and documentation

Audun Wigum Arbo edited this page May 22, 2018 · 1 revision

This page describes how to install the system, how to run the unit tests, and how to generate and view the code documentation. The documentation has for convenience already been generated and been attached to the bachelor thesis files. The locations of the documentation is in the folders described below.

Backend

Requirements

Installation

  1. Clone the project with git clone --recurse-submodules https://github.com/RevolveNTNU/R18_LiveDashServer
  2. Navigate to the cloned folder, run dotnet build -c Release to build the project

Running

  1. Navigate to the output folder (usually LiveDashServer\bin\Release\netcoreapp2.0 on Windows)
  2. Run dotnet LiveDashServer.dll to start the application

Running tests

  1. Run dotnet test in the root folder of the project

Generating documentation

  1. Install DocFX by following the instructions at https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html (see step 2).
  2. Run docfx in the LiveDashServer folder (where the docfx.json is located)
  3. The documentation should now be generated in LiveDashServer/_site/api/LiveDashServer.html

Frontend

Requirements

  • Node.js and NPM if you want to transpile code or generate documentation
  • You should run npm install in the project root directory if you want to transpile code or generate documentation

Installation and running

The web application is currently ready to use out-of-the box after downloading/cloning. You need to run an instance of LiveDashServer on localhost:8080 to get live data.

To transpile the code for browsers that doesn't support ES2015 modules, you need NPM. Run npm run-script build in the project's root folder.

Generating documentation

To generate the documentation, run ./node_modules/.bin/esdoc in the root folder of the project. If the generation was successful, the documentation should be located in the docs/index.html file.