@hywax/nue-kit

Nue Kit

A simple and flexible Electron app kit

🎯 Features

• 👌️ Ease of Use: Simple and easy to understand API
• 🪝 Hooks: A flexible system for working with hooks
• 📦 Modules: A modular system for working with the application
• 🌐 Locales: A system for working with translations
• 💾 Store: A simple store for working with data
• 🏭 Production Ready: Ready for production use
• 🪄️ TypeScript Support: Full TypeScript support

✨ Installation

# Using pnpm
pnpm add @hywax/nue-kit -D

# Using yarn
yarn add @hywax/nue-kit -D

# Using npm
npm install @hywax/nue-kit -D

⚡ Usage

To fully explore all the features of Nue Kit, check out the repository for a ready-made starter template

import { BrowserWindow, app } from 'electron'
import { createNue, createStore } from '@hywax/nue-kit'

function createMainWindowApp() {
  const store = createStore()

  const mainWindow = new BrowserWindow({
    ...store.get('app.mainWindowPosition'),
    width: 800,
    height: 480,
  })

  return createNue({
    store,
    window: mainWindow,
    isProduction: false,
    singleInstance: true,
    locales: { /* ... */ },
    modules: [],
  })
}

app.whenReady().then(async () => {
  const awesomeApp = createMainWindowApp()
  await awesomeApp.hooks.callHook('electron:created', nue)
})

🏆 Contributors

A huge thank you to everyone who is helping to improve. Thanks to you, the project can evolve!

📄 License

The Nue Kit is based on open source code, according to MIT License.