8866 Scouting App

Welcome to the 8866 Scouting App! This application is designed to assist in collecting and analyzing data for scouting purposes during robotics competitions. Below you will find instructions on how to set up, use, and contribute to the project.

Table of Contents

1. Features
2. Installation
3. Usage
4. File Structure
5. Contributing
6. License

Features

• Pre-game selections including match number, team number, alliance color, and match type.
• Scoring options for the autonomous and teleoperated phases.
• End game options including win, lose, tie, park, deep, and shallow.
• QR code generation for match data.
• User-friendly interface for easy navigation and operation.

Installation

Download the available files from the release.

Prerequisites

• Node.js and npm (Node Package Manager) installed on your machine.
• A modern web browser.

Steps

1. Clone the repository:

   git clone https://github.com/frc8866/Scouting.git
   cd Scouting

2. Install dependencies:

   npm install

3. Start the application:

   npm start

4. Open your web browser and navigate to http://localhost:3000 to use the application.

5. Or go to https://frc8866.github.io/Scouting to test it out

Usage

Pre-Game Selections

Enter the match number and team number. Select the alliance color and match type. Click the "Start Scouting" button to proceed to the game section.

Game Section

Click the "Start Game" button to begin the timer. Use the buttons provided to record scoring options for both the autonomous and teleoperated phases. Select the end game options as applicable. Click the "Generate QR Code" button to generate a QR code for the match data.

QR Code Generation

• The application generates QR codes offline for easy sharing of match data.

File Structure

ScoutingApp/
├── public/
│   ├── index.html
│   └── styles.css
├── src/
│   └── script.js
├── .gitignore
├── README.md
└── qrcode.js

Contributing

We welcome contributions to the 8866 Scouting App! To contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes.
4. Commit your changes:

   git commit -m 'Add some feature'

5. Push to the branch:

   git push origin feature/your-feature-name

6. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Thank you for using the 8866 Scouting App! We hope it helps you in your competitions and data analysis.