Skip to content

trvsvrgd/sleeper-stream-scribe

Repository files navigation

Sleeper Stream Scribe (Sleeper Scout)

Frontend for the Available Players Tracker for Sleeper fantasy football leagues. Dashboard, settings, and filters; consumes a separate backend for NFL data, injury reports, and recommendations.

Tech stack

  • Vite, TypeScript, React, shadcn-ui, Tailwind CSS
  • TanStack Query, react-hook-form, zod, recharts

Local development

Requirements: Node.js and npm (nvm recommended).

git clone <YOUR_GIT_URL>
cd sleeper-stream-scribe
nvm install
nvm use
npm run setup:dev
npm run dev

npm run setup:dev installs dependencies, creates .env.local from .env.example when missing, and runs tests.

To connect the backend API, set VITE_API_BASE_URL in .env.local.

Scripts

  • npm run dev — Start dev server
  • npm run setup:dev — Bootstrap local environment (install + env template + test run)
  • npm run build — Production build
  • npm run preview — Preview production build
  • npm run lint — Run ESLint
  • npm run test — Run tests (Vitest)

Deploy (Vercel)

Deploy this repo via Vercel: connect the GitHub repo and use the default Vite build settings (build command: npm run build, output directory: dist). Custom domain can be configured in the Vercel project settings.

Docs

  • TECH_SPEC.md — Intent, requirements, testing standards
  • PLAN.md — Roadmap and Backend Repo Spec

About

A high-performance React frontend for tracking available fantasy football players in Sleeper leagues. Built with Vite, TypeScript, and TanStack Query, it provides a specialized dashboard for identifying streaming candidates through advanced filtering, sorting, and future ML-driven recommendations.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages