Skip to content

gatool is a tool to provide FIRST® Game Announcers with up to date information while announcing events during the FIRST Robotics season. As a web-based tool, it uses up-to-date information about the event to provide a comprehensive set of useful data to Game Announcers. It is designed to work on desktops, laptops and tablet devices.

Notifications You must be signed in to change notification settings

arthurlockman/gatool-api

Repository files navigation

GATool API

gatool-api deploy status

gatool is a tool to provide FIRST® Game Announcers with up to date information while announcing events during the FIRST Robotics season. As a web-based tool, it uses up-to-date information about the event to provide a comprehensive set of useful data to Game Announcers. It is designed to work on desktops, laptops and tablet devices. In a pinch, it can be used on a mobile phone.

gatool relies on data from APIs provided by **FIRST **, The Blue Alliance, statbotics.io, and FTCScout as well as its own data sources. We created the gatool APIs to provide a single access point for the gatool and for other tools that want to use its data. We ask that if you build a tool that uses gatool APIs, that you include "Data provided by the FIRST Game Announcer Tool API" and a link to this page in your application/service.

Watch an overview of gatool on YouTube to learn more!

Contributions

We welcome any and all contributions! Please feel free to fork the repository and contribute back to our development. Issues can be filed in the GitHub issue tracker.

Development

Quick Start

The fastest way to run the API locally:

./run-local.sh

This script will automatically:

  • Start Redis in Docker
  • Check Azure authentication
  • Build and run the API

The API will be available at http://localhost:5000/swagger

Detailed Setup

For detailed local development instructions, see:

Prerequisites

API Documentation

All endpoints are served from:

https://api.gatool.org/

🚀 NEW: All API documentation (including types!) is auto-generated and available at https://api.gatool.org/swagger/

About

gatool is a tool to provide FIRST® Game Announcers with up to date information while announcing events during the FIRST Robotics season. As a web-based tool, it uses up-to-date information about the event to provide a comprehensive set of useful data to Game Announcers. It is designed to work on desktops, laptops and tablet devices.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •