mirror of
https://github.com/amorphous-engineering/OPAL.git
synced 2026-09-02 02:40:38 +00:00
No description
- Python 67%
- HTML 29.7%
- CSS 1.9%
- JavaScript 0.6%
- Shell 0.4%
- Other 0.4%
| .github/workflows | ||
| migrations | ||
| src/opal | ||
| tests | ||
| .env.example | ||
| .gitignore | ||
| alembic.ini | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| install-prerelease.ps1 | ||
| install-prerelease.sh | ||
| install.ps1 | ||
| install.sh | ||
| ISSUES_AUDIT.md | ||
| LICENSE | ||
| opal.spec | ||
| OPAL_manual.md | ||
| pyproject.toml | ||
| README.md | ||
| uv.lock | ||
OPAL
Operations, Procedures, Assets, Logistics
An enterprise resource planning system optimized for small teams and hardware projects.
Download
Install with a single command:
# macOS / Linux
curl -LsSf https://raw.githubusercontent.com/amorphous-engineering/OPAL/master/install.sh | sh
# Windows (PowerShell)
irm https://raw.githubusercontent.com/amorphous-engineering/OPAL/master/install.ps1 | iex
Or download manually from GitHub Releases:
| Platform | File |
|---|---|
| macOS (Apple Silicon) | opal-macos-arm64 |
| macOS (Intel) | opal-macos-x86_64 |
| Linux (x86_64) | opal-linux-x86_64 |
| Windows (x86_64) | opal-windows-x86_64.exe |
Run it. The launcher initializes the database on first launch, starts the server, and opens the web UI. No Python or dependencies required.
Prereleases (beta builds)
To install the latest tagged prerelease (e.g. a beta) instead of the latest stable:
# macOS / Linux
curl -LsSf https://raw.githubusercontent.com/amorphous-engineering/OPAL/master/install-prerelease.sh | sh
# Windows (PowerShell)
irm https://raw.githubusercontent.com/amorphous-engineering/OPAL/master/install-prerelease.ps1 | iex
Or download a specific build manually from GitHub Releases — prereleases are tagged Pre-release. Prereleases are preview builds; expect rough edges and don't rely on them for production data.
Features
- Inventory & Procurement: Parts database, inventory tracking, purchase order management
- Procedures: Versioned procedure templates with step-by-step execution
- Issues: Manual and auto-created issue tracking
- Onshape Integration: Bidirectional BOM and metadata sync with Onshape CAD
- Local-first: Runs on a single laptop, accessible to network
Development Setup
# Install uv (if not installed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install dependencies
uv sync
# Initialize database
uv run opal init
# Start server
uv run opal serve
Access the web UI at http://localhost:8080
Development
# Install with dev dependencies
uv sync --all-extras
# Run tests
uv run pytest
# Generate migration
uv run opal migrate generate --message "Description"
# Apply migrations
uv run opal migrate upgrade
Stack
- Database: SQLite
- Backend: Python 3.11+ with FastAPI
- Frontend: HTMX + Jinja2 templates
- Desktop App: Textual TUI launcher with auto-updater