Skip to content

ionyx-apps/ionyx-examples

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 

Repository files navigation

Ionyx Framework Examples

Real-world applications built with Ionyx Framework. Explore, learn, and get inspired!

Quick Start

Clone and Run

# Clone the examples repository
git clone https://github.com/ionyx-apps/ionyx-examples.git

# Navigate to an example
cd ionyx-examples/todo-app

# Install dependencies
npm install

# Run the example
npm run ionyx-dev

Create from Template

# Create new app from example template
npx create-ionyx-app my-app --template todo-app

# Navigate to your app
cd my-app

# Start development
npm run ionyx-dev

Featured Examples

Todo App

A complete todo application with file persistence and notifications.

Technologies: React, TypeScript, File System API
Features: Add/Edit/Delete todos, Categories, File persistence, Notifications

View Code | Live Demo

File Manager

Cross-platform file manager with drag-and-drop support.

Technologies: Vue.js, File API, Drag & Drop
Features: File operations, Directory navigation, Search, File preview

View Code | Live Demo

🎡 Music Player

Desktop music player with playlist management and controls.

Technologies: Svelte, Audio API, Media Controls
Features: Play/Pause/Skip, Volume control, Playlist management, Album art

View Code | Live Demo

πŸ’» Code Editor

Lightweight code editor with syntax highlighting and file management.

Technologies: Vanilla JS, Monaco Editor, File API
Features: Syntax highlighting, File tree, Search/Replace, Themes

View Code | Live Demo

🌀️ Weather App

Weather application with location services and forecasts.

Technologies: React, Weather API, Location Services
Features: Current weather, Forecasts, Location detection, Maps

View Code | Live Demo

πŸ’¬ Chat App

Real-time chat application with WebSocket support.

Technologies: Vue.js, WebSocket, Real-time
Features: Real-time messaging, User presence, File sharing, Emojis

View Code | Live Demo

πŸ—‚οΈ Browse by Category

πŸ“Š Productivity

🎬 Media

πŸ”§ Development

πŸ“± Communication

πŸ› οΈ Technology Stack

Frontend Frameworks

  • React - Modern React with TypeScript
  • Vue.js - Progressive JavaScript framework
  • Svelte - Cybernetically enhanced web apps
  • Vanilla JS - Plain JavaScript and HTML

Backend Features

  • File System - File operations and management
  • Network - HTTP requests and API calls
  • OS Integration - System information and controls
  • Security - Permission management and sandboxing

UI Libraries

  • Tailwind CSS - Utility-first CSS framework
  • Material UI - React component library
  • Bootstrap - Popular CSS framework
  • Custom CSS - Handcrafted designs

πŸ“¦ Project Structure

Each example follows a consistent structure:

example-name/
β”œβ”€β”€ src-ionyx/          # Rust backend
β”‚   β”œβ”€β”€ main.rs        # Application entry point
β”‚   β”œβ”€β”€ config.rs       # Configuration management
β”‚   β”œβ”€β”€ window.rs       # Window management
β”‚   β”œβ”€β”€ bridge.rs       # IPC bridge
β”‚   β”œβ”€β”€ protocol.rs     # IPC protocol
β”‚   └── security.rs     # Security layer
β”œβ”€β”€ frontend/           # Frontend application
β”‚   β”œβ”€β”€ src/            # Source code
β”‚   β”œβ”€β”€ public/         # Static assets
β”‚   β”œβ”€β”€ package.json    # Dependencies
β”‚   └── vite.config.ts  # Build configuration
β”œβ”€β”€ ionyx.config.toml   # Ionyx configuration
β”œβ”€β”€ package.json        # Root dependencies
β”œβ”€β”€ Cargo.toml          # Rust workspace
└── README.md           # Example documentation

🎯 Getting Started Guide

1. Prerequisites

  • Rust: 1.70+ (latest stable)
  • Node.js: 18+ or newer
  • npm: 8+ or newer

2. Choose an Example

Browse the examples above and choose one that matches your needs and technology stack.

3. Clone and Run

# Clone the repository
git clone https://github.com/ionyx-apps/ionyx-examples.git

# Navigate to your chosen example
cd ionyx-examples/[example-name]

# Install dependencies
npm install

# Run in development mode
npm run ionyx-dev

4. Explore the Code

  • Backend: Check src-ionyx/ for Rust backend code
  • Frontend: Explore frontend/src/ for UI code
  • Configuration: Review ionyx.config.toml for settings
  • Documentation: Read the example's README.md

5. Build for Production

# Build the application
npm run ionyx-build

# Find the built executable
ls -la bundle/

πŸ”§ Customization

Modify Configuration

Edit ionyx.config.toml to customize:

  • Window size and behavior
  • Permissions and security settings
  • Development options
  • Build configuration

Add New Features

  • Backend: Add new IPC commands in src-ionyx/bridge.rs
  • Frontend: Implement new UI components and logic
  • Styling: Customize the appearance with CSS or UI libraries

Package for Distribution

# Create installer
npm run ionyx:build-installer

# Find installers
ls -la installers/

🀝 Contributing

We welcome contributions! Here's how you can help:

Submit New Examples

  1. Fork the repository
  2. Create a new folder for your example
  3. Follow the project structure
  4. Add comprehensive documentation
  5. Submit a pull request

Improve Existing Examples

  • Fix bugs and issues
  • Add new features
  • Improve documentation
  • Optimize performance

Report Issues

  • Bug reports
  • Feature requests
  • Documentation improvements
  • Performance issues

πŸ“š Learning Resources

🎨 Design Guidelines

UI/UX Best Practices

  • Follow platform conventions (Windows, macOS, Linux)
  • Use appropriate icons and imagery
  • Ensure responsive design
  • Implement keyboard shortcuts
  • Provide clear user feedback

Code Quality

  • Follow language-specific conventions
  • Write clear, documented code
  • Include error handling
  • Add unit tests where appropriate
  • Use consistent naming

Performance

  • Optimize bundle size
  • Minimize memory usage
  • Implement lazy loading
  • Use efficient algorithms
  • Profile and optimize bottlenecks

πŸ“„ License

All examples are licensed under the MIT License. Feel free to use, modify, and distribute them as you see fit.

πŸ”— Links


πŸš€ Ionyx Framework - Desktop applications made simple!

ionyx-examples

Examples with Ionyx apps

a24073cc5a27fda0f7aeac951c2b6a73f0ce1057

About

Examples with Ionyx apps

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors