Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Eryxon Flow - Environment Configuration
# Copy this file to .env and fill in your values

# =============================================================================
# SUPABASE CONFIGURATION (Required)
# =============================================================================
# Get these from your Supabase project dashboard: Settings -> API

# Your Supabase project URL
VITE_SUPABASE_URL="https://your-project-id.supabase.co"

# Supabase anon/public key (safe to expose in frontend)
VITE_SUPABASE_PUBLISHABLE_KEY="your-anon-key-here"

# Supabase project ID (the part before .supabase.co)
VITE_SUPABASE_PROJECT_ID="your-project-id"

# =============================================================================
# OPTIONAL CONFIGURATION
# =============================================================================

# App title (shown in browser tab)
# VITE_APP_TITLE="Eryxon Flow"

# Default language (en, nl, de)
# VITE_DEFAULT_LANGUAGE="en"

# =============================================================================
# SELF-HOSTED NOTES
# =============================================================================
#
# For self-hosted deployments:
# 1. Create a Supabase project (cloud or self-hosted)
# 2. Apply the database schema from supabase/migrations/
# 3. Deploy edge functions: supabase functions deploy
# 4. Configure storage buckets: parts-images, issues
# 5. Set these environment variables
#
# See docs/SELF_HOSTING_GUIDE.md for complete instructions.
#
# License: BSL 1.1 - Self-hosting is free and unlimited.
# You cannot offer commercial hosted versions that compete with eryxon.eu
116 changes: 116 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
Business Source License 1.1

License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
"Business Source License" is a trademark of MariaDB Corporation Ab.

-----------------------------------------------------------------------------

Parameters

Licensor: Sheet Metal Connect e.U.
Licensed Work: Eryxon Flow
The Licensed Work is (c) 2025 Sheet Metal Connect e.U.
Additional Use Grant: You may make use of the Licensed Work, provided that
you do not use the Licensed Work for a Production Use
that is Competing with any offering of the Licensor.

A Production Use is Competing if it offers to third
parties access to the Licensed Work in a manner that
competes with or substitutes for the Licensor's own
commercial hosting offering of the Licensed Work.

For clarity, the following uses are expressly permitted:

1. Self-hosting the Licensed Work for your own internal
business operations, regardless of organization size

2. Using the Licensed Work for development, testing,
evaluation, and educational purposes

3. Offering consulting, integration, or customization
services built around the Licensed Work

4. Creating derivative works for your own internal use

Change Date: Four years from the date the Licensed Work is published

Change License: Apache License, Version 2.0

-----------------------------------------------------------------------------

Terms

The Licensor hereby grants you the right to copy, modify, create derivative
works, redistribute, and make non-production use of the Licensed Work. The
Licensor may make an Additional Use Grant, above, permitting limited
production use.

Effective on the Change Date, or the fourth anniversary of the first publicly
available distribution of a specific version of the Licensed Work under this
License, whichever comes first, the Licensor hereby grants you rights under
the terms of the Change License, and the rights granted in the paragraph
above terminate.

If your use of the Licensed Work does not comply with the requirements
currently in effect as described in this License, you must purchase a
commercial license from the Licensor, its affiliated entities, or authorized
resellers, or you must refrain from using the Licensed Work.

All copies of the original and modified Licensed Work, and derivative works
of the Licensed Work, are subject to this License. This License applies
separately for each version of the Licensed Work and the Change Date may vary
for each version of the Licensed Work released by Licensor.

You must conspicuously display this License on each original or modified copy
of the Licensed Work. If you receive the Licensed Work in original or
modified form from a third party, the terms and conditions set forth in this
License apply to your use of that work.

Any use of the Licensed Work in violation of this License will automatically
terminate your rights under this License for the current and all other
versions of the Licensed Work.

This License does not grant you any right in any trademark or logo of
Licensor or its affiliates (provided that you may use a trademark or logo of
Licensor as expressly required by this License).

TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
TITLE.

MariaDB hereby grants you permission to use this License's text to license
your works, and to refer to it using the trademark "Business Source License",
as long as you comply with the Covenants of Licensor below.

-----------------------------------------------------------------------------

Covenants of Licensor

In consideration of the right to use this License's text and the "Business
Source License" name and trademark, Licensor covenants to MariaDB, and to all
other recipients of the licensed work to be provided by Licensor:

1. To specify as the Change License the GPL Version 2.0 or any later version,
or a license that is compatible with GPL Version 2.0 or a later version,
where "compatible" means that software provided under the Change License can
be included in a program with software provided under GPL Version 2.0 or a
later version. Licensor may specify additional Change Licenses without
limitation.

2. To either: (a) specify an additional grant of rights to use that does not
impose any additional restriction on the right granted in this License, as
the Additional Use Grant; or (b) insert the text "None".

3. To specify a Change Date.

4. Not to modify this License in any other way.

-----------------------------------------------------------------------------

Notice

The Business Source License (this document, or the "License") is not an Open
Source license. However, the Licensed Work will eventually be made available
under an Open Source License, as stated in this License.
106 changes: 62 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,27 @@
# Eryxon Flow - Manufacturing Execution System
# Eryxon MES

**Internal Project - Proprietary**
**The simple, elegant and powerful manufacturing execution system that your people will love to use. Made for SMB metal fabrication.**

<div align="center">

[![License: BSL 1.1](https://img.shields.io/badge/License-BSL_1.1-blue?style=for-the-badge)](LICENSE)
[![React](https://img.shields.io/badge/React-18.3.1-61DAFB?style=for-the-badge&logo=react&logoColor=black)](https://reactjs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.8.3-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Vite](https://img.shields.io/badge/Vite-5.4.19-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
[![Supabase](https://img.shields.io/badge/Supabase-2.80.0-3ECF8E?style=for-the-badge&logo=supabase&logoColor=white)](https://supabase.com/)
[![TailwindCSS](https://img.shields.io/badge/Tailwind-3.4.17-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white)](https://tailwindcss.com/)

</div>

<div align="center">

![React Query](https://img.shields.io/badge/React_Query-5.83.0-FF4154?style=flat-square&logo=react-query&logoColor=white)
![React Router](https://img.shields.io/badge/React_Router-6.30.1-CA4245?style=flat-square&logo=react-router&logoColor=white)
![MUI](https://img.shields.io/badge/Material_UI-7.3.5-007FFF?style=flat-square&logo=mui&logoColor=white)
![Three.js](https://img.shields.io/badge/Three.js-0.180.0-000000?style=flat-square&logo=three.js&logoColor=white)
![Zod](https://img.shields.io/badge/Zod-3.25.76-3E67B1?style=flat-square&logo=zod&logoColor=white)
![i18next](https://img.shields.io/badge/i18next-25.6.2-26A69A?style=flat-square&logo=i18next&logoColor=white)

</div>

---

<div align="center">

![Commits](https://img.shields.io/badge/commits-559-blue)
![Inception](https://img.shields.io/badge/inception-2025-11-09-lightgrey)
![Velocity](https://img.shields.io/badge/last_30d-559_commits-orange)
## What Makes This Different

</div>

---
- **MCP Server** - AI/automation ready out of the box
- **API-first** - Send data from any system
- **Webhooks** - Link to any other system
- **Event-driven, real-time** - Industry 4.0 ready
- **Modern UI** - Operators actually want to use it

A modern, production-ready MES (Manufacturing Execution System) for sheet metal manufacturing with real-time tracking, QRM capacity management, and comprehensive API integration.
It's opinionated. Built for sheet metal manufacturing. Not for everyone.

## ✨ Key Features

Expand Down Expand Up @@ -116,39 +102,71 @@ Additional documentation:
- **API Security**: Bearer token auth with bcrypt-hashed keys
- **Webhooks**: HMAC-SHA256 signatures for verification

## 📦 Deployment
## Pricing

| Environment | Platform | Details |
|-------------|----------|---------|
| **Development** | [Lovable](https://lovable.dev/projects/aaa3208a-70fb-4eb6-a5eb-5823f025e734) | Auto-syncs with GitHub |
| **Production** | Docker on Hetzner | EU-hosted, fixed costs |
| **Local/On-Premise** | Docker | Same image, custom Supabase |
| | Free | Pro | Premium | Enterprise | Self-hosted |
|---|---|---|---|---|---|
| **Price** | €0 | €97/mo | €497/mo | By request | €0 |
| **Where** | My infra | My infra | My infra | Your infra | Your infra |
| **Jobs/mo** | 25 | 500 | Fair use | Unlimited | Unlimited |
| **Parts/mo** | 250 | 5,000 | Fair use | Unlimited | Unlimited |
| **Storage** | 500MB | 10GB | 100GB | Your cost | Your cost |
| **API** | Limited | Full | Full | Full | Full |
| **Webhooks** | No | Yes | Yes | Yes | Yes |
| **MCP Server** | No | Yes | Yes | Yes | Yes |
| **SSO/SAML** | No | No | Yes | Yes | DIY |
| **White-label** | No | No | Optional | Yes | DIY |
| **Support** | Docs | Email | Priority | Dedicated | Community |

### CI/CD Pipeline
- **Free** — Try it. Very limited.
- **Pro** — Real usage, my infra, email support.
- **Premium** — High limits, SSO, priority support. Still my infra.
- **Enterprise** — Your network, I deploy, custom scope. Contact me.
- **Self-hosted** — On your own. Free forever.

- **PRs**: Automated lint, type-check, build, test
- **Releases**: Manual workflow with migrations and Edge Functions deployment
- **Docker Images**: Published to GitHub Container Registry (GHCR)
Paid plans billed yearly. Want to self-host? See the [Self-Hosting Guide](docs/SELF_HOSTING_GUIDE.md).

See **[docs/CICD_DEPLOYMENT_PLAN.md](docs/CICD_DEPLOYMENT_PLAN.md)** for full setup instructions.
Need integration work or custom forks? [Contact us](mailto:[email protected]).

### Quick Docker Run
## Deployment

### Self-Hosted (Free)

```bash
# Clone and configure
git clone https://github.com/SheetMetalConnect/eryxon-flow.git
cd eryxon-flow
cp .env.example .env
# Edit .env with your Supabase credentials

# Run with Docker
docker-compose up -d
```

See **[docs/SELF_HOSTING_GUIDE.md](docs/SELF_HOSTING_GUIDE.md)** for complete setup instructions.

### Docker Quick Start

```bash
docker pull ghcr.io/sheetmetalconnect/eryxon-flow:latest
docker run -p 8080:80 ghcr.io/sheetmetalconnect/eryxon-flow:latest
docker run -p 8080:80 \
-e VITE_SUPABASE_URL=your-url \
-e VITE_SUPABASE_PUBLISHABLE_KEY=your-key \
ghcr.io/sheetmetalconnect/eryxon-flow:latest
```

## 📄 License
## License

**Business Source License 1.1 (BSL 1.1)**

**Proprietary - Internal Use Only**
- You can view, modify, and self-host the code for your own use - free, unlimited
- You cannot offer commercial hosted versions that compete with our SaaS
- After 4 years, converts to Apache 2.0

Copyright © 2025 Sheet Metal Connect e.U. All rights reserved.
See [LICENSE](LICENSE) for full terms.

This software is for internal use only and may not be distributed, copied, or modified without explicit permission.
Copyright © 2025 Sheet Metal Connect e.U.

---

**Built with** React 18 + TypeScript + Supabase
**Status**: Production
**Version**: 1.2
**Built with** React + TypeScript + Supabase | **Region**: EU (Netherlands)
Loading
Loading