Quick Start
Get Eryxon Flow running in under 10 minutes.
Prerequisites
Section titled “Prerequisites”Step 1: Set Up Supabase (5 minutes)
Section titled “Step 1: Set Up Supabase (5 minutes)”1.1 Create Project
Section titled “1.1 Create Project”- Go to supabase.com → New Project
- Name it
eryxon-flow - Save your database password
- Click Create
- Wait ~2 minutes for setup
1.2 Get Your Keys
Section titled “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
Section titled “1.3 Apply Database Schema”- Go to SQL Editor
- Copy contents of
supabase/schema.sqlfrom this repo - Paste and click Run
Step 2: Run the Application (3 minutes)
Section titled “Step 2: Run the Application (3 minutes)”git clone https://github.com/your-org/eryxon-flow.gitcd eryxon-flow
npm install
cp .env.example .envEdit .env:
VITE_SUPABASE_URL=https://your-project-id.supabase.coVITE_SUPABASE_PUBLISHABLE_KEY=your-anon-keyStart the app:
npm run devStep 3: Create Your Account (1 minute)
Section titled “Step 3: Create Your Account (1 minute)”- Click Sign Up
- Enter email and password
- Verify email (check inbox)
- You’re now admin of your organization!
Step 4: Explore (Optional)
Section titled “Step 4: Explore (Optional)”Load Demo Data
Section titled “Load Demo Data”Want to see the app with sample data?
- Go to Settings → Organization
- Click Load Demo Data
- Explore sample jobs, parts, and operations
Quick Tour
Section titled “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?
Section titled “What’s Next?”- Self-Hosting Guide - Production deployment options
- API Documentation - REST API reference
- MCP Integration - AI assistant integration
- App Architecture - Deep dive into features
- FAQ - Frequently asked questions
Common Issues
Section titled “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?
Section titled “Need Help?”- Check the full documentation
- Open an issue on GitHub
- Join our community discussions
Happy manufacturing!