Ferrocodex is a secure configuration management platform designed specifically for industrial equipment and operational technology environments. Built with Tauri 2.0, it combines the power of Rust's security and performance with React's modern UI capabilities to deliver an offline-first solution for managing critical infrastructure configurations.

• 🔒 Enterprise-grade Security: Role-based access control, session management, and audit trails
• 💾 Offline-First Architecture: Full functionality without internet connectivity
• 🔐 Data Protection: AES-256 encryption for all stored configurations (coming in v2.0)
• 🌐 Cross-Platform: Native desktop apps for Windows, macOS, and Linux
• 🎯 OT-Focused: Designed for industrial control systems and equipment
• 📝 Comprehensive Audit Trail: Track all configuration changes and access
• 🌳 Version Control: Built-in branching and versioning for configurations
• 👥 Multi-User Support: Administrator and Engineer role separation

• 🏗️ Complete Asset Hierarchy System: Tree-based navigation with drag-and-drop, virtualized rendering for large datasets
• 🔍 Advanced Search & Filtering: SQLite FTS5 full-text search with sub-200ms performance
• 📦 Bulk Operations: Import/export, bulk rename, and batch metadata updates
• ⌨️ Keyboard Navigation: Full keyboard shortcuts for power users
• 🔄 Workflow Management: Multi-step workflows with draft management and progress tracking
• 🛡️ Enhanced Security: Asset name validation, file integrity checks, and compliance indicators
• 📊 Metadata Management: Dynamic schemas, field templates, and conditional logic
• 📈 Performance Optimized: Virtualized tree rendering, optimized search indexes, and efficient caching

• Node.js: 18+
• Rust: 1.78.0+
• Platform-specific dependencies:
  • Linux: libwebkit2gtk-4.1-dev, build-essential, curl, wget, file, libgtk-3-dev, librsvg2-dev
  • macOS: Xcode Command Line Tools
  • Windows: Microsoft Visual Studio C++ Build Tools

1. Clone the repository:

   git clone https://github.com/HillviewCap/ferrocodex.git
   cd ferrocodex

2. Install dependencies:

   npm install

3. Install platform dependencies (Linux example):

   sudo apt update
   sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file libgtk-3-dev librsvg2-dev

Download the latest release for your platform from the releases page.

# Start the development server (both frontend and backend)
npm run dev

# Or from the desktop app directory
cd apps/desktop
npm run tauri:dev

The application will start with hot reload enabled for both the React frontend and Rust backend.

# Build all packages
npm run build

# Build platform-specific binary
cd apps/desktop
npm run tauri:build

# Run all tests
npm run test

# Frontend tests with coverage
cd apps/desktop
npm run test:coverage

# Backend tests
cargo test --manifest-path apps/desktop/src-tauri/Cargo.toml

ferrocodex/
├── apps/
│   └── desktop/              # Main Tauri application
│       ├── src/              # React frontend
│       │   ├── components/   # UI components
│       │   │   ├── hierarchy/     # Asset tree views and navigation
│       │   │   ├── forms/         # Dynamic metadata forms
│       │   │   ├── security/      # Security validation components
│       │   │   ├── workflow/      # Multi-step workflow components
│       │   │   ├── bulk/          # Bulk operations UI
│       │   │   └── metadata/      # Metadata management
│       │   ├── store/        # Zustand state management
│       │   ├── types/        # TypeScript types
│       │   └── utils/        # Utility functions
│       ├── src-tauri/        # Rust backend
│       │   └── src/
│       │       ├── assets/        # Equipment management
│       │       ├── associations/  # File associations
│       │       ├── audit/         # Audit logging
│       │       ├── auth/          # Authentication
│       │       ├── branches/      # Configuration branching
│       │       ├── bulk/          # Bulk operations backend
│       │       ├── configurations/# Config file management
│       │       ├── database/      # SQLite layer with FTS5
│       │       ├── encryption/    # AES-256 encryption
│       │       ├── metadata/      # Dynamic metadata & search
│       │       ├── security/      # Security validation
│       │       ├── users/         # User management
│       │       ├── validation/    # Input validation
│       │       └── workflow/      # Workflow management
│       └── package.json      
├── packages/
│   └── shared-types/         # Shared TypeScript types
├── .github/
│   └── workflows/           # GitHub Actions
├── CLAUDE.md                # AI assistant instructions
├── SECURITY.md              # Security policy
└── package.json             # Workspace configuration

Ferrocodex stores its data in platform-specific locations:

• Windows: %APPDATA%/com.ferrocodex.app/
• macOS: ~/Library/Application Support/com.ferrocodex.app/
• Linux: ~/.config/com.ferrocodex.app/

The SQLite database is automatically initialized on first run with:

• WAL mode for better concurrency
• Optimized pragma settings
• Automatic schema migrations

We welcome contributions! Please see our Contributing Guide for details.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

• Follow the existing code style
• Add tests for new functionality
• Update documentation as needed
• Ensure all tests pass before submitting

Security is paramount for OT environments. Please report vulnerabilities responsibly:

• DO NOT open public issues for security vulnerabilities
• Email security@ferrocodex.com with details
• See SECURITY.md for more information

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

This means that any modifications or derivative works must also be released under the AGPL-3.0 license, and if you run a modified version on a server, you must offer the source code to users of that server.

Built with:

• Tauri - Build smaller, faster, and more secure desktop applications
• React - A JavaScript library for building user interfaces
• Ant Design - Enterprise-class UI design language
• Rust - Performance, reliability, and productivity

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions