Skip to content

sifex/scarlet-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scarlet

GitHub Workflow Status

This is the Laravel API for Scarlet – Built by AAF.

Getting Started

# Install
composer install

# Run
sail up -d
sail npm i

Testing

# Feature Tests
sail test

Development

Standard Browser Login

sequenceDiagram
    participant U as User
    participant E as Electron App
    participant B as Browser
    participant L as Laravel Backend
    participant S as Steam

    %% Standard Flow
    U->>B: Access "/"
    B->>L: Request "/"
    L-->>B: Return home page
    U->>B: Click login
    B->>L: GET "/login/steam"
    L-->>B: Redirect to Steam
    B->>S: Redirect to Steam login
    U->>S: Enter credentials
    S-->>B: Redirect to "/auth/steam"
    B->>L: GET "/auth/steam"
    L-->>B: Set session, redirect to app
    B-->>U: Show app features
Loading

Electron Flow

sequenceDiagram
    participant U as User
    participant E as Electron App
    participant B as Browser
    participant L as Laravel Backend
    participant S as Steam
    
    %% Electron Flow
    U->>E: Click Electron login
    E->>B: Open "/browser/steam/verify"
    B->>L: GET "/browser/steam/verify"
    L-->>B: Generate token, redirect to "/login/steam"
    B->>L: GET "/login/steam"
    L-->>B: Redirect to Steam
    B->>S: Redirect to Steam login
    U->>S: Enter credentials
    S-->>B: Redirect to "/auth/steam"
    B->>L: GET "/auth/steam"
    L-->>B: Set session, redirect to "/browser/steam/verify"
    B->>L: GET "/browser/steam/verify" with token
    L-->>B: Redirect to Electron app (deep link)
    B-->>E: Deep link to app
    E->>L: GET "/electron/steam/verify"
    L-->>E: Confirm login, return app data
    E-->>U: Show Electron app interface

Loading

Then open http://localhost