ProStaff API

Ruby on Rails API for the ProStaff.gg esports team management platform.

Key Features (Click to show details)

JWT Authentication with refresh tokens and token blacklisting
Interactive Swagger Documentation (170+ endpoints documented)
Riot Games API Integration for automatic match import and player sync
Advanced Analytics (KDA trends, champion pools, vision control, etc.)
Scouting System with talent discovery and watchlist management
VOD Review System with timestamp annotations
️ Schedule Management for matches, scrims, and team events
Goal Tracking for team and player performance objectives
Competitive Module with PandaScore integration and draft analysis
Scrims Management with opponent tracking and analytics
Strategy Module with draft planning and tactical boards
Support System with ticketing and FAQ management
Background Jobs with Sidekiq for async processing
️ Security Hardened (OWASP Top 10, Brakeman, ZAP tested)
High Performance (p95: ~500ms, with cache: ~50ms)
️ Modular Monolith architecture for scalability

# Start all services (API, PostgreSQL, Redis, Sidekiq)
docker compose up -d

# Create test user
docker exec prostaff-api-api-1 rails runner scripts/create_test_user.rb

# Get JWT token for testing
./scripts/get-token.sh

# Access API docs
open http://localhost:3333/api-docs

# Run smoke tests
./load_tests/run-tests.sh smoke local

# Run security scan
./security_tests/scripts/brakeman-scan.sh

Option 2: Without Docker (Local Development)

# Install dependencies
bundle install

# Generate secrets
./scripts/generate_secrets.sh  # Copy output to .env

# Setup database
rails db:create db:migrate db:seed

# Start Redis (in separate terminal)
redis-server

# Start Sidekiq (in separate terminal)
bundle exec sidekiq

# Start Rails server
rails server -p 3333

# Get JWT token for testing
./scripts/get-token.sh

# Access API docs
open http://localhost:3333/api-docs

API will be available at: http://localhost:3333 Swagger Docs: http://localhost:3333/api-docs

Technology Stack

Ruby: 3.4.5
Rails: 7.2.0 (API-only mode)
Database: PostgreSQL 14+
Authentication: JWT (with refresh tokens)
Background Jobs: Sidekiq
Caching: Redis (port 6380)
API Documentation: Swagger/OpenAPI 3.0 (rswag)
Testing: RSpec, Integration Specs, k6, OWASP ZAP
Authorization: Pundit
Serialization: Blueprinter

Architecture

This API follows a modular monolith architecture with the following modules:

authentication - User authentication and authorization
dashboard - Dashboard statistics and metrics
players - Player management and statistics
scouting - Player scouting and talent discovery
analytics - Performance analytics and reporting
matches - Match data and statistics
schedules - Event and schedule management
vod_reviews - Video review and timestamp management
team_goals - Goal setting and tracking
riot_integration - Riot Games API integration
competitive - PandaScore integration, pro matches, draft analysis
scrims - Scrim management and opponent team tracking
strategy - Draft planning and tactical board system
support - Support ticket system with staff and FAQ management

Architecture Diagram

graph TB
    subgraph "Client Layer"
        Client[Frontend Application]
    end

    subgraph "API Gateway"
        Router[Rails Router]
        CORS[CORS Middleware]
        RateLimit[Rate Limiting]
        Auth[Authentication Middleware]
    end

    subgraph "Application Layer - Modular Monolith"
        subgraph "Authentication Module"
            AuthController[Auth Controller]
            JWTService[JWT Service]
            UserModel[User Model]
        end

        subgraph "Dashboard Module"
            DashboardController[Dashboard Controller]
            DashStats[Statistics Service]
        end

        subgraph "Players Module"
            PlayersController[Players Controller]
            PlayerModel[Player Model]
            ChampionPoolModel[Champion Pool Model]
        end

        subgraph "Scouting Module"
            ScoutingController[Scouting Controller]
            ScoutingTargetModel[Scouting Target Model]
            Watchlist[Watchlist Service]
        end

        subgraph "Analytics Module"
            AnalyticsController[Analytics Controller]
            PerformanceService[Performance Service]
            KDAService[KDA Trend Service]
        end

        subgraph "Matches Module"
            MatchesController[Matches Controller]
            MatchModel[Match Model]
            PlayerMatchStatModel[Player Match Stat Model]
        end

        subgraph "Schedules Module"
            SchedulesController[Schedules Controller]
            ScheduleModel[Schedule Model]
        end

        subgraph "VOD Reviews Module"
            VODController[VOD Reviews Controller]
            VodReviewModel[VOD Review Model]
            VodTimestampModel[VOD Timestamp Model]
        end

        subgraph "Team Goals Module"
            GoalsController[Team Goals Controller]
            TeamGoalModel[Team Goal Model]
        end

        subgraph "Riot Integration Module"
            RiotService[Riot API Service]
            RiotSync[Sync Service]
        end

        subgraph "Competitive Module"
            CompetitiveController[Competitive Controller]
            ProMatchesController[Pro Matches Controller]
            PandaScoreService[PandaScore Service]
            DraftAnalyzer[Draft Analyzer]
        end

        subgraph "Scrims Module"
            ScrimsController[Scrims Controller]
            OpponentTeamsController[Opponent Teams Controller]
            ScrimAnalytics[Scrim Analytics Service]
        end

        subgraph "Strategy Module"
            DraftPlansController[Draft Plans Controller]
            TacticalBoardsController[Tactical Boards Controller]
            DraftAnalysisService[Draft Analysis Service]
        end

        subgraph "Support Module"
            SupportTicketsController[Support Tickets Controller]
            SupportFaqsController[Support FAQs Controller]
            SupportStaffController[Support Staff Controller]
            SupportTicketModel[Support Ticket Model]
            SupportFaqModel[Support FAQ Model]
        end
    end

    subgraph "Data Layer"
        PostgreSQL[(PostgreSQL Database)]
        Redis[(Redis Cache)]
    end

    subgraph "Background Jobs"
        Sidekiq[Sidekiq Workers]
        JobQueue[Job Queue]
    end

    subgraph "External Services"
        RiotAPI[Riot Games API]
        PandaScoreAPI[PandaScore API]
    end

    Client -->|HTTP/JSON| CORS
    CORS --> RateLimit
    RateLimit --> Auth
    Auth --> Router
    
    Router --> AuthController
    Router --> DashboardController
    Router --> PlayersController
    Router --> ScoutingController
    Router --> AnalyticsController
    Router --> MatchesController
    Router --> SchedulesController
    Router --> VODController
    Router --> GoalsController
    Router --> CompetitiveController
    Router --> ProMatchesController
    Router --> ScrimsController
    Router --> OpponentTeamsController
    Router --> DraftPlansController
    Router --> TacticalBoardsController
    Router --> SupportTicketsController
    Router --> SupportFaqsController
    Router --> SupportStaffController
    AuthController --> JWTService
    AuthController --> UserModel
    PlayersController --> PlayerModel
    PlayerModel --> ChampionPoolModel
    ScoutingController --> ScoutingTargetModel
    ScoutingController --> Watchlist
    Watchlist --> PostgreSQL
    MatchesController --> MatchModel
    MatchModel --> PlayerMatchStatModel
    SchedulesController --> ScheduleModel
    VODController --> VodReviewModel
    VodReviewModel --> VodTimestampModel
    GoalsController --> TeamGoalModel
    AnalyticsController --> PerformanceService
    AnalyticsController --> KDAService
    CompetitiveController --> PandaScoreService
    CompetitiveController --> DraftAnalyzer
    ScrimsController --> ScrimAnalytics
    ScrimAnalytics --> PostgreSQL
    DraftPlansController --> DraftAnalysisService
    SupportTicketsController --> SupportTicketModel
    SupportFaqsController --> SupportFaqModel
    SupportStaffController --> UserModel
    AuditLogModel[AuditLog Model] --> PostgreSQL
    ChampionPoolModel[ChampionPool Model] --> PostgreSQL
    CompetitiveMatchModel[CompetitiveMatch Model] --> PostgreSQL
    DraftPlanModel[DraftPlan Model] --> PostgreSQL
    MatchModel[Match Model] --> PostgreSQL
    NotificationModel[Notification Model] --> PostgreSQL
    OpponentTeamModel[OpponentTeam Model] --> PostgreSQL
    OrganizationModel[Organization Model] --> PostgreSQL
    PasswordResetTokenModel[PasswordResetToken Model] --> PostgreSQL
    PlayerModel[Player Model] --> PostgreSQL
    PlayerMatchStatModel[PlayerMatchStat Model] --> PostgreSQL
    ScheduleModel[Schedule Model] --> PostgreSQL
    ScoutingTargetModel[ScoutingTarget Model] --> PostgreSQL
    ScrimModel[Scrim Model] --> PostgreSQL
    SupportFaqModel[SupportFaq Model] --> PostgreSQL
    SupportTicketModel[SupportTicket Model] --> PostgreSQL
    SupportTicketMessageModel[SupportTicketMessage Model] --> PostgreSQL
    TacticalBoardModel[TacticalBoard Model] --> PostgreSQL
    TeamGoalModel[TeamGoal Model] --> PostgreSQL
    TokenBlacklistModel[TokenBlacklist Model] --> PostgreSQL
    UserModel[User Model] --> PostgreSQL
    VodReviewModel[VodReview Model] --> PostgreSQL
    VodTimestampModel[VodTimestamp Model] --> PostgreSQL
    JWTService --> Redis
    DashStats --> Redis
    PerformanceService --> Redis
    PlayersController --> RiotService
    MatchesController --> RiotService
    ScoutingController --> RiotService
    RiotService --> RiotSync
    RiotService --> RiotAPI

    RiotService --> Sidekiq
    PandaScoreService --> PandaScoreAPI[PandaScore API]
    Sidekiq -- Uses --> Redis
    
    style Client fill:#e1f5ff
    style PostgreSQL fill:#336791
    style Redis fill:#d82c20
    style RiotAPI fill:#eb0029
    style PandaScoreAPI fill:#ff6b35
    style Sidekiq fill:#b1003e

Key Architecture Principles:

Modular Monolith: Each module is self-contained with its own controllers, models, and services
API-Only: Rails configured in API mode for JSON responses
JWT Authentication: Stateless authentication using JWT tokens
Background Processing: Long-running tasks handled by Sidekiq
Caching: Redis used for session management and performance optimization
External Integration: Riot Games API integration for real-time data
Rate Limiting: Rack::Attack for API rate limiting
CORS: Configured for cross-origin requests from frontend

Setup

Prerequisites

Ruby 3.2+
PostgreSQL 14+
Redis 6+

Installation

Clone the repository:

git clone <repository-url>
cd prostaff-api

Install dependencies:

bundle install

Setup environment variables:

cp .env.example .env

Edit .env with your configuration:

Database credentials
JWT secret key
Riot API key
Redis URL
CORS origins

Setup the database:

rails db:create
rails db:migrate
rails db:seed

Start the services:

Start Redis:

redis-server

Start Sidekiq (in another terminal):

bundle exec sidekiq

Start the Rails server:

rails server

The API will be available at http://localhost:3333

Development Tools

Generate Secrets

Generate secure secrets for your .env file:

./scripts/generate_secrets.sh

This will generate:

SECRET_KEY_BASE - Rails secret key
JWT_SECRET_KEY - JWT signing key

Get JWT Token (for API testing)

Generate a JWT token for testing the API:

./scripts/get-token.sh

This will:

Create or find a test user (test@prostaff.gg)
Generate a valid JWT token
Show instructions on how to use it

Quick usage:

# Export to environment variable
export BEARER_TOKEN=$(./scripts/get-token.sh | grep -oP 'eyJ[A-Za-z0-9_-]*\.[A-Za-z0-9_-]*\.[A-Za-z0-9_-]*')

# Use in curl
curl -H "Authorization: Bearer $BEARER_TOKEN" http://localhost:3333/api/v1/players

Custom credentials:

TEST_EMAIL="admin@example.com" TEST_PASSWORD="MyPass123!" ./scripts/get-token.sh

📚 API Documentation (Click to show details)

Interactive Documentation (Swagger UI)

The API provides interactive documentation powered by Swagger/OpenAPI 3.0:

Access the docs:

http://localhost:3333/api-docs

Features:

✅ Try out endpoints directly from the browser
✅ See request/response schemas
✅ Authentication support (Bearer token)
✅ Complete parameter documentation
✅ Example requests and responses

Generating/Updating Documentation

The Swagger documentation is automatically generated from RSpec integration tests:

# Run integration specs and generate Swagger docs
bundle exec rake rswag:specs:swaggerize

# Or run specs individually
bundle exec rspec spec/integration/

The generated documentation file is located at swagger/v1/swagger.yaml.

Base URL

http://localhost:3333/api/v1

Authentication

All endpoints (except auth endpoints) require a Bearer token in the Authorization header:

Authorization: Bearer <your-jwt-token>

Token Details:

Access Token: Expires in 24 hours (configurable via JWT_EXPIRATION_HOURS)
Refresh Token: Expires in 7 days
Token Type: Bearer (JWT)

Getting a token:

# Option 1: Use the script
./scripts/get-token.sh

# Option 2: Login via API
curl -X POST http://localhost:3333/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"test@prostaff.gg","password":"Test123!@#"}'

Refreshing a token:

curl -X POST http://localhost:3333/api/v1/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{"refresh_token":"your-refresh-token"}'

Authentication Endpoints

POST /auth/register - Register new organization and admin user
POST /auth/login - Login user
POST /auth/refresh - Refresh JWT token
POST /auth/logout - Logout user
POST /auth/forgot-password - Request password reset
POST /auth/reset-password - Reset password
GET /auth/me - Get current user info

Core Endpoints

Dashboard

GET /dashboard - Get complete dashboard data
GET /dashboard/stats - Get quick stats
GET /dashboard/activities - Get recent activities
GET /dashboard/schedule - Get upcoming schedule

Players

GET /players - List players
GET /players/:id - Get player details
POST /players - Create player
PATCH /players/:id - Update player
DELETE /players/:id - Delete player
GET /players/stats - Get roster statistics
POST /players/import - Import player from Riot API

Matches

GET /matches - List matches
GET /matches/:id - Get match details
POST /matches - Create match
POST /matches/import - Import match from Riot API

Scouting

GET /scouting/players - List scouting targets
GET /scouting/regions - Get available regions
POST /scouting/players - Add scouting target

Analytics

GET /analytics/performance - Team performance analytics
GET /analytics/team-comparison - Compare all players
GET /analytics/champions/:player_id - Champion pool statistics
GET /analytics/kda-trend/:player_id - KDA trend over time
GET /analytics/laning/:player_id - Laning phase performance
GET /analytics/teamfights/:player_id - Teamfight performance
GET /analytics/vision/:player_id - Vision control statistics

Schedules

GET /schedules - List all scheduled events
GET /schedules/:id - Get schedule details
POST /schedules - Create new event
PATCH /schedules/:id - Update event
DELETE /schedules/:id - Delete event

Team Goals

GET /team-goals - List all goals
GET /team-goals/:id - Get goal details
POST /team-goals - Create new goal
PATCH /team-goals/:id - Update goal progress
DELETE /team-goals/:id - Delete goal

VOD Reviews

GET /vod-reviews - List VOD reviews
GET /vod-reviews/:id - Get review details
POST /vod-reviews - Create new review
PATCH /vod-reviews/:id - Update review
DELETE /vod-reviews/:id - Delete review
GET /vod-reviews/:id/timestamps - List timestamps
POST /vod-reviews/:id/timestamps - Create timestamp
PATCH /vod-timestamps/:id - Update timestamp
DELETE /vod-timestamps/:id - Delete timestamp

Riot Data

GET /riot-data/champions - Get champions ID map
GET /riot-data/champions/:key - Get champion details
GET /riot-data/all-champions - Get all champions data
GET /riot-data/items - Get all items
GET /riot-data/summoner-spells - Get summoner spells
GET /riot-data/version - Get current Data Dragon version
POST /riot-data/clear-cache - Clear Data Dragon cache (owner only)
POST /riot-data/update-cache - Update Data Dragon cache (owner only)

Riot Integration

GET /riot-integration/sync-status - Get sync status for all players

Competitive (PandaScore Integration)

GET /competitive-matches - List competitive matches
GET /competitive-matches/:id - Get competitive match details
GET /competitive/pro-matches - List all pro matches
GET /competitive/pro-matches/:id - Get pro match details
GET /competitive/pro-matches/upcoming - Get upcoming pro matches
GET /competitive/pro-matches/past - Get past pro matches
POST /competitive/pro-matches/refresh - Refresh pro matches from PandaScore
POST /competitive/pro-matches/import - Import specific pro match
POST /competitive/draft-comparison - Compare team compositions
GET /competitive/meta/:role - Get meta champions by role
GET /competitive/composition-winrate - Get composition winrate statistics
GET /competitive/counters - Get champion counter suggestions

Scrims Management

GET /scrims/scrims - List all scrims
GET /scrims/scrims/:id - Get scrim details
POST /scrims/scrims - Create new scrim
PATCH /scrims/scrims/:id - Update scrim
DELETE /scrims/scrims/:id - Delete scrim
POST /scrims/scrims/:id/add_game - Add game to scrim
GET /scrims/scrims/calendar - Get scrims calendar
GET /scrims/scrims/analytics - Get scrims analytics
GET /scrims/opponent-teams - List opponent teams
GET /scrims/opponent-teams/:id - Get opponent team details
POST /scrims/opponent-teams - Create opponent team
PATCH /scrims/opponent-teams/:id - Update opponent team
DELETE /scrims/opponent-teams/:id - Delete opponent team
GET /scrims/opponent-teams/:id/scrim-history - Get scrim history with opponent

Strategy Module

GET /strategy/draft-plans - List draft plans
GET /strategy/draft-plans/:id - Get draft plan details
POST /strategy/draft-plans - Create new draft plan
PATCH /strategy/draft-plans/:id - Update draft plan
DELETE /strategy/draft-plans/:id - Delete draft plan
POST /strategy/draft-plans/:id/analyze - Analyze draft plan
PATCH /strategy/draft-plans/:id/activate - Activate draft plan
PATCH /strategy/draft-plans/:id/deactivate - Deactivate draft plan
GET /strategy/tactical-boards - List tactical boards
GET /strategy/tactical-boards/:id - Get tactical board details
POST /strategy/tactical-boards - Create new tactical board
PATCH /strategy/tactical-boards/:id - Update tactical board
DELETE /strategy/tactical-boards/:id - Delete tactical board
GET /strategy/tactical-boards/:id/statistics - Get tactical board statistics
GET /strategy/assets/champion/:champion_name - Get champion assets
GET /strategy/assets/map - Get map assets

Support System

GET /support/tickets - List user's tickets
GET /support/tickets/:id - Get ticket details
POST /support/tickets - Create new support ticket
PATCH /support/tickets/:id - Update ticket
DELETE /support/tickets/:id - Delete ticket
POST /support/tickets/:id/close - Close ticket
POST /support/tickets/:id/reopen - Reopen ticket
POST /support/tickets/:id/messages - Add message to ticket
GET /support/faq - List all FAQs
GET /support/faq/:slug - Get FAQ by slug
POST /support/faq/:slug/helpful - Mark FAQ as helpful
POST /support/faq/:slug/not-helpful - Mark FAQ as not helpful
GET /support/staff/dashboard - Support staff dashboard (staff only)
GET /support/staff/analytics - Support analytics (staff only)
POST /support/staff/tickets/:id/assign - Assign ticket to staff (staff only)
POST /support/staff/tickets/:id/resolve - Resolve ticket (staff only)

For complete endpoint documentation with request/response examples, visit /api-docs

🧪 Testing

Unit & Request Tests

Run the complete test suite:

bundle exec rspec

Run specific test types:

# Unit tests (models, services)
bundle exec rspec spec/models
bundle exec rspec spec/services

# Request tests (controllers)
bundle exec rspec spec/requests

# Integration tests (Swagger documentation)
bundle exec rspec spec/integration

Integration Tests (Swagger Documentation)

Integration tests serve dual purpose:

Test API endpoints with real HTTP requests
Generate Swagger documentation automatically

# Run integration tests and generate Swagger docs
bundle exec rake rswag:specs:swaggerize

# Run specific integration spec
bundle exec rspec spec/integration/players_spec.rb

Current coverage:

✅ Authentication (8 endpoints)
✅ Players (9 endpoints)
✅ Matches (11 endpoints)
✅ Scouting (10 endpoints)
✅ Schedules (8 endpoints)
✅ Team Goals (8 endpoints)
✅ VOD Reviews (11 endpoints)
✅ Analytics (7 endpoints)
✅ Riot Data (14 endpoints)
✅ Riot Integration (1 endpoint)
✅ Dashboard (4 endpoints)
✅ Competitive (14 endpoints)
✅ Scrims (14 endpoints)
✅ Strategy (16 endpoints)
✅ Support (15 endpoints)

Total: 170+ endpoints documented

Code Coverage

View coverage report after running tests:

open coverage/index.html

Deployment

Environment Variables

Required environment variables for production:

DATABASE_URL=postgresql://user:password@host:5432/database
REDIS_URL=redis://host:6379/0
JWT_SECRET_KEY=your-production-secret
RIOT_API_KEY=your-riot-api-key
CORS_ORIGINS=https://your-frontend-domain.com
SECRET_KEY_BASE=your-rails-secret

Docker

A Dockerfile is provided for containerized deployment:

docker build -t prostaff-api .
docker run -p 3333:3000 prostaff-api

CI/CD

Architecture Diagram Auto-Update

This project includes an automated workflow that keeps the architecture diagram in sync with the codebase:

Trigger: Automatically runs when changes are made to:
- app/modules/** - Module definitions
- app/models/** - Data models
- app/controllers/** - Controllers
- config/routes.rb - Route definitions
- Gemfile - Dependencies
Process:
1. GitHub Actions workflow detects relevant code changes
2. Runs scripts/update_architecture_diagram.rb
3. Script analyzes project structure (modules, models, controllers, services)
4. Generates updated Mermaid diagram
5. Updates README.md with new diagram
6. Commits changes back to the repository
Manual Update: You can also manually update the diagram:
```
ruby scripts/update_architecture_diagram.rb
```

The diagram automatically reflects:

New modules added to app/modules/
New models created
New controllers and routes
Service integrations (Riot API, Redis, PostgreSQL, Sidekiq)

📊 Performance & Testing

Load Testing (k6)

# Quick smoke test (1 min)
./load_tests/run-tests.sh smoke local

# Full load test (16 min)
./load_tests/run-tests.sh load local

# Stress test (28 min)
./load_tests/run-tests.sh stress local

Current Performance:

p(95): ~880ms (Docker dev)
Production estimate: ~500ms
With cache: ~50ms
Error rate: 0%

Documentation: See TESTING_GUIDE.md and QUICK_START.md

Security Testing (OWASP)

# Complete security audit
./security_tests/scripts/full-security-audit.sh

# Individual scans
./security_tests/scripts/brakeman-scan.sh          # Code analysis
./security_tests/scripts/dependency-scan.sh        # Vulnerable gems
./security_tests/scripts/zap-baseline-scan.sh      # Web app scan

Coverage:

✅ OWASP Top 10
✅ Code security (Brakeman)
✅ Dependency vulnerabilities
✅ Runtime security (ZAP)
✅ CI/CD integration

Documentation: See security_tests/README.md

CI/CD Workflows

Automated testing on every push:

Security Scan: Brakeman + dependency check
Load Test: Nightly smoke tests
Nightly Audit: Complete security scan

See .github/workflows/ for details.

Contributing

Create a feature branch
Make your changes
Add tests
Run security scan: ./security_tests/scripts/brakeman-scan.sh
Ensure all tests pass
Submit a pull request

Note: The architecture diagram will be automatically updated when you add new modules, models, or controllers.

License

Copyright e Licenciamento

Este repositório contém o código-fonte oficial da API para a plataforma de e-sports ProStaff.gg.

O código-fonte contido aqui é disponibilizado sob a licença Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Você pode encontrar o texto completo da licença no arquivo LICENSE neste repositório.

Shield:

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Disclaimer

Prostaff.gg isn't endorsed by Riot Games and doesn't reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties.

Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc.

Name	Name	Last commit message	Last commit date
Latest commit History 201 Commits
.github	.github
.security	.security
DOCS	DOCS
app	app
backups	backups
bin	bin
config	config
db	db
deploy	deploy
lib/tasks	lib/tasks
load_tests	load_tests
scripts	scripts
security_tests	security_tests
spec	spec
swagger/v1	swagger/v1
.brakeman.ignore	.brakeman.ignore
.env.example	.env.example
.env.production.example	.env.production.example
.env.staging.example	.env.staging.example
.gitignore	.gitignore
.rubocop.yml	.rubocop.yml
.semgrepignore	.semgrepignore
Dockerfile	Dockerfile
Dockerfile.production	Dockerfile.production
Gemfile	Gemfile
Gemfile.lock	Gemfile.lock
PLAYER_IMPORT_SECURITY.md	PLAYER_IMPORT_SECURITY.md
README.md	README.md
Rakefile	Rakefile
config.ru	config.ru
docker-compose.production.yml	docker-compose.production.yml
docker-compose.staging.yml	docker-compose.staging.yml
docker-compose.yml	docker-compose.yml
license.md	license.md
render.yaml	render.yaml

Search code, repositories, users, issues, pull requests...

Uh oh!

License

Bulletdev/prostaff-api

Folders and files

Latest commit

History

Repository files navigation

ProStaff API

Table of Contents

Option 1: With Docker (Recommended)

Option 2: Without Docker (Local Development)

Technology Stack

Architecture

Architecture Diagram

Setup

Prerequisites

Installation

Development Tools

Generate Secrets

Get JWT Token (for API testing)

Interactive Documentation (Swagger UI)

Generating/Updating Documentation

Base URL

Authentication

Authentication Endpoints

Core Endpoints

Dashboard

Players

Matches

Scouting

Analytics

Schedules

Team Goals

VOD Reviews

Riot Data

Riot Integration

Competitive (PandaScore Integration)

Scrims Management

Strategy Module

Support System

🧪 Testing

Unit & Request Tests

Integration Tests (Swagger Documentation)

Code Coverage

Deployment

Environment Variables

Docker

CI/CD

Architecture Diagram Auto-Update

📊 Performance & Testing

Load Testing (k6)

Security Testing (OWASP)

CI/CD Workflows

Contributing

License

Disclaimer

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 3

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Contributors 5

Uh oh!

Languages

Packages