hyperio

README

Hyperio

Hyperio is a modern desktop application that provides tools for prossess management and metrics monitoring. Built with Wails (Go + ReactJs), it enables developers to create, monitor, and control their scripts dynamic.

Hyperio is derived from Hyperion of Greek mythology. He was one of the twelve Titans and was regarded as the god of observation.

Key Features

Process Manager

• Schedule the execution of programs
• Send commands to the running programs
• Consume commands and metrics from the running programs

Technology Stack

Frontend

• React 18 with TypeScript
• Material UI (MUI) for modern, consistent design
• Vite for fast development and building
• Modern CSS with responsive design
• Real-time data visualization libraries
• MUI Data Grid for advanced data tables

Backend

• Go 1.23+ for high-performance trading operations
• Wails v2 framework for desktop integration
• NATS messaging system for real-time communication

Prerequisites

• Go 1.23 or later
• Node.js v20 or later
• NATS server (optional, for production)
• Wails CLI (go install github.com/wailsapp/wails/v2/cmd/wails@latest)

Quick Start

1. Clone the repository:

   git clone https://github.com/rangertaha/Hyperio.git
   cd Hyperio
   

2. Install dependencies:

   # Install Go dependencies
   go mod download
   
   # Install frontend dependencies
   cd frontend
   npm install
   cd ..
   

3. Start development:

   wails dev
   

Development

Local Development

1. Start the development server:

   wails dev
   

   The application will be available at: http://localhost:34115

2. Build the application:

   wails build
   

Testing

Run the test suite:

go test ./...

Build

Create a production build:

wails build -production

The built application will be available in the build/bin directory.

Project Structure

Hyperio/
├── frontend/           # React frontend application
│   ├── src/           # Source files
│   │   ├── components/  # UI components
│   │   ├── pages/      # Page components
│   │   └── utils/      # Utility functions
│   ├── dist/          # Built frontend files
│   └── package.json   # Frontend dependencies
├── main.go            # Application entry point
├── app.go             # Main application logic
└── wails.json        # Wails configuration

Configuration

The application can be configured through:

• wails.json for Wails-specific settings
• Environment variables for runtime configuration
• NATS connection settings (if using external NATS server)

Troubleshooting

Common issues and solutions:

1. Build fails

   • Ensure all prerequisites are installed
   • Check Go and Node.js versions
   • Clear build cache: wails clean

2. NATS connection issues

   • Verify NATS server is running
   • Check connection settings
   • Ensure proper network access

License

This project is licensed under the terms included in the LICENSE file.

Contributing

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

Support

For support, please:

1. Check the troubleshooting section
2. Search existing issues
3. Create a new issue if needed