Quick Start

Get Eryxon Flow up and running.

Just want to explore? Try the live demo at app.eryxon.eu — no setup needed. Sign up and start exploring immediately.

---

Prerequisites

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

---

Step 1: Set Up Supabase

1.1 Create Project

1. Go to supabase.com → New Project
2. Name it eryxon-flow
3. Save your database password
4. 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

1. Go to SQL Editor
2. Copy contents of supabase/schema.sql from this repo
3. Paste and click Run

---

Step 2: Run the Application

git clone https://github.com/your-org/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

Start the app:

npm run dev

Open http://localhost:8080

---

Step 3: Create Your Account

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

---

Step 4: Explore (Optional)

Load Demo Data

Want to see the app with sample data?

1. Go to Settings → Organization
2. Click Load Demo Data
3. 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/terminal	Shop floor interface
/admin/config/stages	Configure workflow stages

---

What’s Next?

Setup & Deployment:

• Self-Hosting Guide - Production deployment options
• MCP Server Setup - AI assistant integration setup

API & Integration:

• REST API Documentation - Complete API reference
• MCP Demo Guide - AI assistant usage examples
• Connectivity Overview - Integration architecture
• Webhooks & MQTT - Event-driven integration
• Swagger/OpenAPI - Available in the app at /api-docs

Architecture & Help:

• App Architecture - System design overview
• Database Schema - Data model reference
• 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?

• Check the documentation
• Open an issue on GitHub
• Join our community discussions

---

Happy manufacturing!