Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.17 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.17 KB

Solar Car Telemetry Framework

This project is currently a Work In Progress

This is a front-end framework that allows for beautiful(ish) visualization of data coming from a Solar Car in real-time.

Split up your data into groups and define a module for each of these groups, point each module at a data source, a websocket connection or a polling HTTP request.

Goal

The goal of this project is to create a simple framework that can easily be expanded to accomidate new telemetry data and new ways of displaying data.

This framework should provide a solid foundation for displaying telemetry data in a somewhat beautiful way while being accessible to inexperienced users (easy to use and configure).

Documentation

Documentation is coming soon.

Building and Running

To build and run Solar Car Telemetry locally you need to have Node.js installed, or an IDE that will transpile LESS and TypeScript.

Do the following when in a terminal inside this project directory:

  1. Install developer dependencies
npm install
  1. Run Build Tasks
gulp
  1. Start the HTTP server
cd build
http-server
  1. Open Web browser
http://localhost:8080