ravyn-framework

Ravyn

A modern Electron-based application framework with hot-reloading capabilities, available as an npm package.

Features

• Hot module replacement for rapid development
• Configurable window management
• Built-in logging system
• Preload script support
• URL handling capabilities

Quick Start

1. Install the package:

   npm install ravyn
   # or
   yarn add ravyn

2. Import and use in your Electron app:

   import { whenReady, defineWindowConfig } from 'ravyn';
   
   whenReady().then(() => {
     defineWindowConfig({
       // Your window configuration
     });
   });

Configuration

Edit src/config.ts to customize:

• Window defaults
• Development settings
• Logger preferences

API Reference

Exported Functions

• whenReady(): Returns a Promise that resolves when Electron is ready
• defineWindowConfig(config): Defines window configuration options
• enableHotReload(): Enables hot module replacement
• configureLogger(options): Configures the built-in logger

Contributing

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

License

MIT