This repository is a Docker microservice that exposes endpoints to manipulate data that will be processed by other microservices, including robototes-website-web and robototes-website-team. Currently, our only endpoint is a The Blue Alliance webhook.
For common documentation regarding the requirements, upkeep, and testing of our microservices, please see our global documentation. Sections regarding microservice-specific configuration, features, and differences in commands can be found below.
The following environment variables can be set, the server will not start without the ones marked required:
IP(required, default0.0.0.0) The IP to run the server onPORT(required, default3000) The port to listen for requests onDOMAIN(required) The second-level domain that the server resides onDEBUG(optional) see Debug modeTBA_SECRET_KEY(required) The secret key used to verify the source and integrity of payloads from The Blue AllianceDATABASE_HOST(required) The IP address that the MongoDB server is listening onDATABASE_PORT(required) The port that the MongoDB server is listening on
Debug mode does not change the behavior of any endpoints, but the debug module is still in
use. The recommended debug filter for this project is robototes-website-api:*,http.
The Blue Alliance is a service provided free of charge to FRC teams for scouting, watching, and reliving the FIRST Robotics Competition. One such feature in particular that we use is a subscription to webhooks that provide us with realtime event updates. We use these webhooks to build a customized feed for our users with all events regarding our team.
@dannytech and @TAKBS2412
See our common CONTRIBUTING.md