ASF FarmDeck

Local control center for ArchiSteamFarm (ASF), focused on day-to-day operations and premium monitoring.

Author

• Mauricio Vuljevas
• Site: www.mvuljevas.com
• GitHub: github.com/mvuljevas
• Repository: github.com/mvuljevas/asf-farmdeck

Goals

• Run and supervise ASF reliably.
• Visualize farming progress (games, cards, time, bots).
• Consolidate configuration and operations into one local app.
• Scale to multiple accounts and plugins without losing operational control.

Project Structure

• runtime/asf/: ASF runtime managed by ASF FarmDeck (isolated from app code).
• templates/: internal templates and presets used by FarmDeck onboarding/bootstrap.
• docs/: minimal project documentation.
• src/: frontend app shell, features, shared client utilities, and design-system components.
• server/: backend bootstrap, routes, services, shared server utilities, and SQLite integration.

Code Layout

• src/design-system/: reusable UI atoms and organisms.
• src/features/: view-level slices such as dashboard, bots, config, games, and profile flows.
• src/shared/: frontend types, API client, and formatting helpers.
• server/routes/: API route registration split by concern.
• server/services/: ASF orchestration, polling, cache, and state assembly.
• server/lib/: backend shared types, env paths, file helpers, and database bootstrap.
• server/lib/asfOfficialResources.ts: official ASF references and expected release asset names for bootstrap work.

Quick Start

1. Install dependencies:
   • npm install
2. Start your stable dev session:
   • npm run dev:user
3. Open:
   • ASF FarmDeck UI: http://127.0.0.1:5173
   • ASF FarmDeck API: http://127.0.0.1:4570
   • ASF IPC/UI: http://127.0.0.1:1242

Dev Modes

• npm run dev:user
  • Main working session (recommended for your daily work).
  • Web: 5173, API: 4570.
• npm run dev:qa
  • Secondary parallel session for smoke/tests (QA/Playwright).
  • Web: 3001, API: 3002.
• npm run smoke
  • Runs Playwright smoke tests against the QA session.

Validation

• npm run lint
  • Static checks for frontend and backend code.
• npm run build
  • TypeScript build plus production frontend bundle.
• npm run smoke
  • Playwright smoke pass for the integrated shell.

Docs

• Product roadmap: docs/ROADMAP.md
• AI agent instructions: docs/AGENTS.md