Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.55 KB

README.md

File metadata and controls

34 lines (20 loc) · 1.55 KB

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.

You will need a login to access the tool. All registered GAs and MCs will receive an invitation with a login and password.

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

This section has information on how to build and deploy the project.

Building

GAtool's backend is built on nodejs. To run the application, run:

git clone [email protected]:arthurlockman/gatool-api.git
cd gatool-api
npm i
npm run start

The app won't be able to do anything without proper Azure key authentication. This means development outside our core team will be difficult.

Deployment

GAtool is deployed on Azure. We are using Azure Block Storage for user uploads, and Azure VMs to host the service itself. We deploy using PM2 to our hosts.