Skip to content

Latest commit

 

History

History
 
 

Pitwall.Web.App

README.md

Virtual Pitwall

The Virtual Pitwall platform displays all relevant iRacing event data on a web-based dashboard for race engineers.

Project Frameworks

Core Frameworks and Libraries:

Project URLs

CI/CD

A passing build and at least one approval is required to merge. Changes merged to main branch will be automatically deployed to https://staging.virtualpitwall.com. This typically takes less than 5 minutes. If the CI build fails, test the build locally and ensure there are no errors or warnings: npm run build-dev (or build-staging).

Data Model

The best way to explore the data model is to use redux devtools and view the chart and object properties. Be sure to select the appropriate web app in the drop down. The main redux states that will be used for retrieving iRacing event data are pitwall.gameSession, pitwall.liveTiming, and pitwall.telemetry. The pitwall.session state is used to track pitwall-specific data, no race event data should be retrieved from there.

Model Overview: VirtualPitwallReduxModel

Game Session Data: VirtualPitwallReduxGameSession

Live Timing Data: VirtualPitwallReduxStandings

Telemetry Data: VirtualPitwallReduxTelemetry

Development Setup

The Virtual Pitwall comes with a Dev Containers setup for Visual Studio Code. This contains all the tools and configurations, that are needed to develop the UI. To use this functionality, you need to have Docker installed, as well as the Dev Containers extension.

Code formatting

For code formatting we use Prettier, to format the code as well as ESLint, to lint the code.

To make sure, that the code is formatted before being committed, we use husky as a pre-commit hook in combination with lint-staged. This formats the code before committing it. Or as the lint-staged repo phrases it:

Run linters against staged git files and don't let 💩 slip into your code base!

START OF AUTO GEN Next.js DOCUMENTATION

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.