Virtual Pitwall
The Virtual Pitwall platform displays relevant iRacing data on a web-based dashboard for race engineers.
Projects
Project URLs
- App Url: https://staging.virtualpitwall.com
- API Url: https://staging.api.virtualpitwall.com
- API Swagger Url (not particularly useful since most data comes from websockets): https://staging.api.virtualpitwall.com/swagger
Discord
If you plan to work a feature/component, please use the discord for communicating to avoid conflicts and duplicate efforts. It's not the greatest project managemnt plan, but it'll work for now. https://discord.gg/k3A3cTaVNy
Getting Started
The following steps are for running every project locally for development.
- Follow the Getting Started sections for the following projects
- Open the Pitwall.sln solution in Visual Studio
- Right click the Pitwall Solution and select "Configure Startup Projects"
- Set the "Action" for
docker-composeandPitwall.Windows.Appto "Start" - Start the project using the "Start" command in the top toolbar
- For the Windows App, ensure the DomainConfiguration is set to point to the local API.
- Open the Pitwall.Web.App folder in VS Code.
- Run the following command
npm run dev-localwhich will use the localserver env file
- Run the following command
- All of the projects should now be running locally and iRacing can be started.
CI/CD
A passing build and at least one approval is required to merge. Changes merged to main branch will be automatically deployed to the staging environment. This typically takes less than 5 minutes. The Windows App is released and deployed with a version number matching the format [YEAR-2023].[MONTH].[DAY].[MINUTES]. The Windows App will automatically check for updates on app start.
If the CI build fails, test the build locally with the configuration used on CI to ensure there are no errors or warnings. For the web app, run npm run build-dev (or build-staging). For the API and Windows App, set the configuration to Release and attempt the build.