<img src="repo/images/icon.png" align="right" width="128" />

<div id="toc">
  <ul style="list-style: none; padding-left: 0px;">
    <summary>
      <h1>Open Scouting</h1>
    </summary>
  </ul>
</div>

**An open source application for easier scouting at FIRST Robotics competitions**

**[Live Server](https://open-scouting.shortcircuitfirst.org) • [Releases](https://github.com/FRC-Team3484/open-scouting/releases) • [Issues](https://github.com/FRC-Team3484/open-scouting/issues) • [Discord](https://discord.gg/M3wESZUP35)**

<a href="https://skills.syvixor.com">
  <img src="https://skills.syvixor.com/api/icons?perline=15&i=svelte,vite,vitepwa,fastapi,tailwindcss,shadcnui&radius=60" />
</a>

---

<img src="./repo/images/mockup.png">

## Features
- Works on any modern device, without needing scouting specific devices
- Full offline support
- Uses [The Blue Alliance](https://thebluealliance.com) to automate parts of the scouting process
- Quick, UI based match and pit field editing, allowing instant season setup
- Anyone can view and contribute data
- Support for custom events if they're missing on The Blue Alliance
- Collaborative pit scouting
- Match data view with summaries and charts
- Create an account for settings sync
- Admin panel for server management
- Quick links to scouting at events

## Installation
- Follow the steps in [Development Installation](/docs/development-installation.md) for how to get Open Scouting up and running locally for development or contributing
- Follow the steps in [Production Installation](/docs/production-installation.md) for how to get Open Scouting installed on a server for production use

## Contributing
Contributions are always welcome! Please see the [issues](https://github.com/FRC-Team3484/open-scouting/issues) page and the [milestones](https://github.com/FRC-Team3484/open-scouting/milestones) for the next things that need worked on.

Additionally, there's a document explaining how to use several systems provided in the client that may be needed while adding new features [here](/docs/client-systems.md).

When contributing, please fork this repository (ensure you uncheck the "Copy the `main` branch only" check box, this gives you access to any of the upcoming version branches with the latest changes.)

Next, create a new branch and implement your changes. You can install this project locally for testing by following the steps in [Development Installation](#development-installation). Once you've made your changes, please open a pull request into the next version branch, and your changes will be reviewed and merged

Eventually, that version branch will be merged into `main` and your changes will be released into production with a new release. Thanks for your contribution!