Deploy and Host Dashfy on Railway

Dashfy is an open-source framework for building dashboards as code. Instead of clicking through a UI, you define dashboards in TypeScript, JSON, or YAML, connect any API through extensions, and Dashfy renders real-time interfaces over WebSockets. This template deploys the official Dashfy demo in one click.

About Hosting Dashfy

Dashfy runs as a server–client app. The Dashfy server (Node.js, Fastify, and Socket.IO) loads your dashboard configuration, connects to APIs and data sources, and streams data to the client in real time. This template deploys the official demo as a single Railway service: the build step compiles the Vite + React client into build/, and the server serves that UI and handles the WebSocket connection on the same port. No database or extra services are required for the minimal demo. Railway assigns an HTTPS domain automatically, and you can add your own custom domain any time under Networking.

Common Use Cases

Developer dashboards for APIs, CI/CD pipelines, and infrastructure
Internal tools and operational visibility without building custom UI
Real-time API and service observability
Wall, TV, and kiosk dashboards with fullscreen and rotation
Trying Dashfy before integrating it into your own stack

Dependencies for Dashfy Hosting

Node.js 20+
pnpm (via packageManager in package.json)
@getdashfy/server and @getdashfy/ui from pnpm (extra widgets via @getdashfy/ext-*)

Deployment Dependencies

Implementation Details

Dashboards are declared in dashfy.config.yml. To customize, eject the repo from the template (Settings → Source → Eject) and edit dashfy.config.yml, dashfy.server.ts, and src/App.tsx.

Why Deploy Dashfy on Railway?

Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying Dashfy on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.