https://github.com/titanscouting/red-alliance-api

NodeJS REST API for interacting with The Red Alliance Mobile App
https://github.com/titanscouting/red-alliance-api

api-server frc-scouting hacktoberfest nodejs

Last synced: about 1 month ago
JSON representation

NodeJS REST API for interacting with The Red Alliance Mobile App

• Host: GitHub
• URL: https://github.com/titanscouting/red-alliance-api
• Owner: titanscouting
• License: bsd-3-clause
• Created: 2019-11-07T05:49:30.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2026-05-04T12:49:51.000Z (about 2 months ago)
• Last Synced: 2026-05-04T14:34:52.424Z (about 2 months ago)
• Topics: api-server, frc-scouting, hacktoberfest, nodejs
• Language: TypeScript
• Homepage:
• Size: 5.05 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md
  • Maintainers: MAINTAINERS

Awesome Lists containing this project

README

          
# The Red Alliance - API

NodeJS REST API for interacting with MongoDB. Backend database for TRA. 

## Deploying the API

* The Docker image has been published to GitHub Packages [here](https://github.com/titanscouting/red-alliance-api/pkgs/container/red-alliance-api%2Fred-alliance-api). It exposes the HTTP interface at port 8190.

## Unit Testing 

* Run `yarn test` to run the Mocha/Chai tests.

## Documenation 

**REST API Documentation**

The REST API documention can be found [here](https://scouting.titanrobotics2022.com). It conforms to the Swagger OpenAPI v2 model and seperates both authenticated and public routes.

**Database handlers and internal documentation**

~~Documentation for internal APIs can be found [here](https://titanscouting.github.io/red-alliance-api/).~~

DB Handler docs are currently not rendered, please check in src/db-handlers/ for the TypeDoc annotations.

## Status Badges

![Unit Testing](https://github.com/titanscouting/red-alliance-api/workflows/Run%20Unit%20tests/badge.svg)

![Linting](https://github.com/titanscouting/red-alliance-api/workflows/Lint%20the%20API/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/titanscouting/red-alliance-api/badge.svg?branch=master)](https://coveralls.io/github/titanscouting/red-alliance-api?branch=master)