FRC Web Components

FRC Web Components (FWC) is a web-based dashboard used for the FIRST Robotics Competition (FRC).

FWC can be either installed as a standalone application, or as a javascript package for custom dashboard solutions.

Installation

The standalone Tauri application that wraps around FWC can be installed here: https://github.com/frc-web-components/app/releases

To install using npm:

npm i @frc-web-components/fwc@latest

Try it out!

A live version of the application can be viewed here: https://frc-web-components.github.io/dashboard/

Documentation

• Component documentation - Component examples and documentation
• Dashboard Interface - Learn how to use the FWC dashboard app
• Plugin Development - Documentation on FWC dashboard plugin development.
• Lit plugin example - An example plugin using the lit-plugin template from the create-fwc cli tool.
• React plugin example - An example plugin using the react-plugin template from the create-fwc cli tool.
• Svelte plugin example - An example plugin using the svelte-plugin template from the create-fwc cli tool.
• React custom dashboard example - An example custom dashboard using the react-custom-dashboard template from the create-fwc cli tool.
• Svelte custom dashboard example - An example custom dashboard using the svelte-custom-dashboard template from the create-fwc cli tool.

Developing

Installing

This project uses the pnpm package manager. Please install pnpm first before proceeding: https://pnpm.io/installation

If using vscode the following extensions are recommended:

• Prettier: Code formatting
• CSS Modules: Used for autocompleting css modules

To install run in the root directory:

pnpm install

Running

To run the project locally run in the root directory:

pnpm dev

Publishing and Releasing

This project uses changesets to manage publishing. More info can be found here: https://pnpm.io/using-changesets