Encore

Encore is a Coral ecosystem module built on TanStack Start, Tailwind v4, and the Jellyfin API. It serves as a template and foundation for building new Coral applications.

Version

Current version: 0.1.0
GHCR image: ghcr.io/get-coral/encore

Getting Started

Prerequisites

Node.js 18+
pnpm (or npm/yarn)

Installation

Clone the repository:

git clone https://github.com/Get-Coral/encore.git
cd encore

Install dependencies:

pnpm install

Configure environment variables:

cp .env.example .env
JELLYFIN_URL=http://your-server:8096
JELLYFIN_API_KEY=your-api-key
JELLYFIN_USER_ID=your-user-id

Start development server:

pnpm dev

Encore runs on http://localhost:3000

Stack

Tool	Purpose
TanStack Start	Full-stack React framework
TanStack Router	Type-safe file-based routing
TanStack Query	Server state management
Tailwind v4	Styling
Biome	Linting & formatting
@get-coral/jellyfin	Jellyfin API client
Vitest	Testing

Available Scripts

pnpm dev        # Start dev server on :3000
pnpm build      # Production build
pnpm start      # Run production server
pnpm typecheck  # TypeScript check
pnpm check      # Biome lint + format check
pnpm lint       # Biome lint with auto-fix
pnpm test       # Run tests

Deployment

Docker

# Build
docker build -t encore .

# Run
docker run -p 3000:3000 \
  -e JELLYFIN_URL=http://your-nas:8096 \
  -e JELLYFIN_API_KEY=your-key \
  -e JELLYFIN_USER_ID=your-user-id \
  encore

CI/CD

Automated workflows handle:

ci.yml - Run on every PR and push (typecheck, lint, test, build)
docker-publish.yml - Publish to GHCR on release
release-please.yml - Automated versioning and releases

Contributing

See Contributing to contribute to Encore.

Repository

Get-Coral/encore on GitHub