Skip to content

Repository files navigation

TypeType

TypeType Frontend

The React web client for TypeType.

This repository contains the browser application and its nginx container. It owns the user interface, routing, settings, account flows, library views, and integration with the TypeType API and playback package.

If you want to install or update a complete TypeType instance, use the central TypeType repository and the self-hosting documentation.

Responsibilities

  • Responsive desktop and mobile interface
  • Search, channels, watch pages, playlists, subscriptions, and history
  • Account, administration, import, and instance settings flows
  • HTTP integration with TypeType-Server
  • Playback UI around @typetype/mse, Vidstack, DASH, and HLS providers
  • Theme, accessibility, and browser behavior

Playback engine internals belong in TypeType-Player. Extraction and user data belong in TypeType-Server.

Stack

AreaTechnology
UIReact 19 and TypeScript
BuildVite 8
Routing and server stateTanStack Router and TanStack Query
Local stateZustand
StylingTailwind CSS 4
Playback shellVidstack, @typetype/mse, dash.js, and hls.js
ToolingBun, Biome, Knip, and Sherif

Development

Requirements:

bun install --frozen-lockfile
cp apps/web/.env.example apps/web/.env
bun run dev

The development server starts at http://localhost:5173 by default.

VariablePurpose
VITE_API_URLAPI URL embedded in the frontend
VITE_DEV_PROXY_TARGETAPI target used by the Vite development proxy

Project structure

PathContents
apps/web/src/routesApplication routes
apps/web/src/componentsShared interface and player components
apps/web/src/hooksQuery and behavior hooks
apps/web/src/libAPI clients, helpers, and integration code
apps/web/src/settingsSettings definitions and controls
apps/web/src/storesClient-side state stores
apps/web/testsFrontend tests

Checks

bun run check
bun run test
bun run knip
bun run sherif
bun run build

Read CONTRIBUTING.md before opening a pull request. Bug reports and feature requests belong in the central issue tracker.

License

TypeType Frontend is licensed under the MIT License. TypeType is not affiliated with, authorized by, or endorsed by YouTube, Google, NicoNico, BiliBili, or their affiliates.

About

Web client for TypeType

Topics

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages