RS UI

RS UI is a Laravel + Inertia + React application for browsing partners, collections, and file-system-like paths backed by an external API.

Tech stack

• Laravel (PHP)
• Inertia.js + React + TypeScript
• Vite
• Tailwind CSS + Radix UI primitives
• Pest (PHP tests)

Prerequisites

• PHP 8.5+
• Composer
• Node.js 20+
• npm

Quick start

ddev composer install
ddev npm install
cp .env.example .env
ddev php artisan key:generate
ddev php artisan migrate
ddev npm run dev

In a second terminal, run:

php artisan serve

Environment configuration

Configure your external API endpoint in .env and ensure the related services.rs.v1.endpoint config resolves correctly. The application depends on an authenticated external session cookie (external_auth_cookie) and expiry timestamp (external_auth_expires) for API-backed actions.

Common commands

# Frontend
ddev npm run dev
ddev npm run build
ddev npm run types
ddev npm run lint
ddev npm run format

# Backend/tests
ddev php artisan test
./vendor/bin/pest
vendor/bin/pint --dirty

Application flow overview

1. Authenticated users enter the dashboard and navigate partners/collections.
2. Collection browsing and file preview/download actions call external API-backed endpoints.
3. Search pages call SearchController, which delegates query execution and pagination to ExternalApiService.
4. React pages render via Inertia responses from Laravel controllers.

Important routes

• GET /dashboard — partners index
• GET /partners/{partner} — partner details
• GET /collections/{collection} — collection details
• GET /paths/{partner}/{collection}/{path?} — path browsing
• GET /preview/{path} — file preview
• GET /download/{path} — file download stream
• GET /search — search page
• GET /api/search — API search endpoint
• GET /api/search/autocomplete — autocomplete endpoint

Project structure

app/
  Http/Controllers/   # Inertia/API controllers
  Services/           # External API integration layer
resources/js/
  components/         # UI and feature components
  pages/              # Inertia page components
  hooks/              # Shared React hooks
tests/                # Pest feature/unit tests

Documentation index

• Test plan (planned tests only): docs/testing-plan.md