https://github.com/minarox/racecast

Interface for displaying race car data.
https://github.com/minarox/racecast

astro highcharts livekit openlayers pwa realtime vite

Last synced: 18 days ago
JSON representation

Interface for displaying race car data.

• Host: GitHub
• URL: https://github.com/minarox/racecast
• Owner: Minarox
• License: apache-2.0
• Created: 2023-05-22T09:20:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-21T09:06:45.000Z (6 months ago)
• Last Synced: 2024-06-22T02:22:18.535Z (6 months ago)
• Topics: astro, highcharts, livekit, openlayers, pwa, realtime, vite
• Language: Astro
• Homepage: https://rallye.minarox.fr
• Size: 2.32 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

        

    





    
RaceCast


![Website version](https://img.shields.io/github/package-json/v/Minarox/RaceCast/main?style=flat&label=Version) 

![Project license](https://img.shields.io/github/license/Minarox/RaceCast?style=flat&label=License) 

![Code size](https://img.shields.io/github/languages/code-size/Minarox/RaceCast?style=flat&label=Code%20size) 

![Website status](https://img.shields.io/website?url=https%3A%2F%2Frallye.minarox.fr&style=flat&label=Website)

  


    Web interface for the RaceCast project to broadcast live data from a rally car.

    


    rallye.minarox.fr »

  






  Table of Contents

- [About](#about)

    - [Built With](#built-with)

- [Getting Started](#getting-started)

    - [Prerequisites](#prerequisites)

    - [Installation](#installation)

    - [Deployment](#deployment)

- [Author](#author)

## About

The RaceCast project is a set of hardware and software solutions enabling a multitude of useful data to be broadcast live to spectators following the race.




This repository contains the Web interface that receives and displays data transmitted from the car, such as the audio/video stream from the onboard camera, and telemetry and GPS data.



### Build With

- [Astro](https://astro.build/)

- [LiveKit](https://livekit.io/)

## Getting Started

### Prerequisites

- NodeJS 20.x or higher

- npm 7.x or higher

### Installation

1. Clone the project

```bash

  git clone https://github.com/Minarox/RaceCast

  cd RaceCast

```

2. Install dependencies

```bash

  npm install

```

3. Create `.env` file at the root of the project with these variables:

```dotenv

PUBLIC_LIVEKIT_WS_URL="wss://example.com"

LIVEKIT_KEY="key"

LIVEKIT_SECRET="secret"

LIVEKIT_ROOM="room"

PUBLIC_ACKEE_URL="https://example.com/tracker.js"

PUBLIC_ACKEE_DOMAIN="abcdef0123-a0b1-0a12-0a12-012a345b6789"

```

4. Start the server

```bash

  npm run dev

```

The development server should start on [localhost:4321](http://localhost:4321/).

### Deployment

The project is configured to be automatically deployed on Cloudflare Pages. 


To compile the project locally, run the following command:

```bash

  npm run build

```

A new `dist` folder will appear containing the entire compiled website.

## Author

[@Minarox](https://www.github.com/Minarox)