Skip to content

LogicSekai/Ares

Repository files navigation

Ares — Nuxt 3 + Electron Desktop Application

📌 Ringkasan

Ares adalah aplikasi desktop berbasis Nuxt 3 dan Electron yang ditulis menggunakan TypeScript. Repository ini berisi konfigurasi lengkap untuk pengembangan, build, dan kontribusi tim dengan workflow yang terstruktur dan scalable.

Dokumentasi ini mencakup:

  • Setup proyek secara lokal
  • Menjalankan aplikasi (development & production)
  • Struktur direktori
  • Aturan dan alur kontribusi (Contributing Guidelines)

🧩 Tech Stack

  • Frontend: Nuxt 3 (Vue 3, Vite)
  • Desktop Runtime: Electron
  • Language: TypeScript
  • Package Manager: Bun / npm / yarn / pnpm
  • Hot Reload: Nuxt HMR + Electron Hot Reload (electronmon)

⚙️ Prasyarat

Pastikan tools berikut sudah terpasang di sistem Anda:

  • Git ≥ v2.x

  • Node.js ≥ v18.x (disarankan LTS)

  • Package Manager (pilih salah satu):

    • bun
    • npm
    • yarn
    • pnpm

🚀 Setup Lokal

1. Clone Repository

git clone <URL-REPO>
cd <NAMA_PROYEK>

2. Konfigurasi Environment

Salin file konfigurasi contoh:

cp .env.example .env

Isi variabel environment di file .env sesuai kebutuhan lokal (misal: database, API key, mode aplikasi, dsb).


3. Instal Dependensi

Gunakan salah satu package manager berikut:

bun install
# atau
npm install
# atau
yarn install
# atau
pnpm install

4. Menjalankan Aplikasi

Mode Development (Nuxt + Electron)

bun run dev

Fitur yang aktif:

  • Nuxt Hot Module Replacement (HMR)
  • Electron auto-restart saat main.ts / preload.ts berubah

Build Production

bun run build

🗂️ Struktur Direktori

ares/
├─ app/                    # Nuxt 3 application
│
├─ electron/               # Electron process
│   ├─ src/
│   │   ├─ main.ts         # Main process
│   │   ├─ preload.ts     # Preload script
│   │   └─ ipc/            # IPC handlers
│   │
│   ├─ dist/               # Compiled Electron output
│   └─ tsconfig.json
│
├─ types/                  # Global TypeScript typings
│
├─ .output/                # Nuxt build output
├─ nuxt.config.ts
├─ package.json
└─ tsconfig.json

About

Ares S-Hub | Macropad control panel and custom builder | Electron JS & Nuxt 3

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors