Quick Start

Get Eryxon Flow up and running.

Just want to explore? Open the hosted version at app.eryxon.eu - no setup needed. It remains online as-is.

Prerequisites

Node.js 20+ (download)
A Supabase account (free tier works) - sign up

Step 1: Set Up Supabase

1.1 Create Project

Go to supabase.com → New Project
Name it eryxon-flow
Save your database password
Click Create

1.2 Get Your Keys

Go to Settings → API and copy:

Project URL (e.g., https://abc123.supabase.co)
anon public key (starts with eyJ...)

1.3 Apply Database Schema

Use the Supabase CLI against your target project:

supabase link --project-ref YOUR_PROJECT_REF
supabase db push

1.4 Apply Seed Data

The seed file sets up storage policies, RLS defaults, and cron jobs:

supabase db execute --file supabase/seed.sql

1.5 Create Storage Buckets

supabase storage create parts-images
supabase storage create issues
supabase storage create parts-cad
supabase storage create batch-images

1.6 Deploy Edge Functions

supabase functions deploy

1.7 Set Edge Function Secrets

Go to Settings → API and copy the service_role key, then:

supabase secrets set SUPABASE_URL=https://YOUR_PROJECT_REF.supabase.co SUPABASE_SERVICE_ROLE_KEY=YOUR_SERVICE_ROLE_KEY

Configure the notify-new-signup Database Webhook after migrations are applied (see Self-Hosting Guide).

Prefer automation? Run bash scripts/setup.sh instead — it walks through all of the above interactively.

Step 2: Run the Application

git clone https://github.com/SheetMetalConnect/eryxon-flow.git
cd eryxon-flow


npm install


cp .env.example .env

Edit .env:

VITE_SUPABASE_URL=https://your-project-id.supabase.co
VITE_SUPABASE_PUBLISHABLE_KEY=your-anon-key
VITE_SUPABASE_PROJECT_ID=your-project-id

Start the app:

npm run dev

Open http://localhost:8080

Step 3: Create Your Account

Click Sign Up
Enter email and password
Verify email (check inbox)
You’re now admin of your organization!

Step 4: Explore (Optional)

Load Demo Data

Want to see the app with sample data?

Go to Settings in the admin sidebar
Click Create Demo Data
Explore sample jobs, parts, and operations

Quick Tour

Page	What it does
`/admin/dashboard`	Production overview
`/admin/jobs`	Manage manufacturing jobs
`/admin/jobs/new`	Create new job
`/operator/work-queue`	Operator task list
`/operator/login`	Shop floor terminal login
`/admin/config/stages`	Configure workflow stages

What’s Next?

Setup & Deployment:

Deployment Guide - Production deployment options
Self-Hosting Guide - Environment and rollout details
MCP Server Setup - AI assistant integration setup

API & Integration:

REST API Overview - Integration architecture
REST API Reference - Complete endpoint reference
API Payload Reference - Copy-paste payload examples
MCP Demo Guide - AI assistant usage examples
Webhooks & MQTT - Event-driven integration
Swagger/OpenAPI - Available in the app at /admin/api-docs (requires login)

Architecture & Help:

App Architecture - System design overview
FAQ - Frequently asked questions

Common Issues

Can’t sign up?

Check your Supabase URL is correct in .env
Verify email settings in Supabase Auth dashboard

Database errors?

Make sure you ran the schema SQL
Check the SQL Editor for any errors

Page not loading?

Verify both environment variables are set
Check browser console for errors

Need Help?

Start from the documentation home
Open an issue on GitHub
Join our community discussions

Happy manufacturing!