https://github.com/jyablonski/nba_elt_rest_api

REST API for NBA ELT Project
https://github.com/jyablonski/nba_elt_rest_api

fastapi python

Last synced: 5 months ago
JSON representation

REST API for NBA ELT Project

• Host: GitHub
• URL: https://github.com/jyablonski/nba_elt_rest_api
• Owner: jyablonski
• Created: 2022-08-03T23:09:22.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2025-11-20T14:46:26.000Z (7 months ago)
• Last Synced: 2025-11-20T16:22:45.091Z (7 months ago)
• Topics: fastapi, python
• Language: Python
• Homepage: https://api.jyablonski.dev
• Size: 1.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# REST API for NBA ELT Project

![CICD](https://github.com/jyablonski/nba_elt_rest_api/actions/workflows/ci_cd.yaml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/jyablonski/nba_elt_rest_api/badge.svg?branch=master)](https://coveralls.io/github/jyablonski/nba_elt_rest_api?branch=master) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

Version: 1.11.2

## About the Project

The REST API has the following functionalities:

- Serves Data built from the NBA ELT Pipeline through various GET endpoints

- Hosts a user-facing Frontend that Allows people to login & make NBA Game Win Predictions and Betting

- Hosts an Internal Admin Frontend w/ various pages to manage things like Feature Flags and other functionality used throughout the project

The Project uses:

- A Postgres Database for the backend

- A Redis Database to enable caching across various endpoints to improve performance

- JWT for Authentication and Authorization

## Running The App

Clone the Repo & run `make up` which spins up the App locally served [here](http://localhost:8080/) using 3 Docker Containers:

- Postgres Database

- Redis Database

- FastAPI Server

To Login to the App locally, a set of Credentials for an Admin User are listed below:

- Username: `test1`

- Password: `password`

When finished run `make down` to spin resources down.

## Tests

To run tests locally, run `make test`.

The same Test Suite is ran after every commit on a PR via GitHub Actions.

## Project

![nba_pipeline_diagram](https://github.com/jyablonski/nba_elt_rest_api/assets/16946556/12d00fcf-1d5a-4ced-a392-b7a8de239ff2)

1. Links to other Repos providing infrastructure for this Project

   - [Dash Server](https://github.com/jyablonski/nba_elt_dashboard)

   - [Ingestion Script](https://github.com/jyablonski/nba_elt_ingestion)

   - [dbt](https://github.com/jyablonski/nba_elt_dbt)

   - [Terraform](https://github.com/jyablonski/aws_terraform)

   - [ML Pipeline](https://github.com/jyablonski/nba_elt_mlflow)

   - [Interal Documentation](https://github.com/jyablonski/doqs)