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)
- 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)
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
git clone <URL-REPO>
cd <NAMA_PROYEK>Salin file konfigurasi contoh:
cp .env.example .envIsi variabel environment di file .env sesuai kebutuhan lokal
(misal: database, API key, mode aplikasi, dsb).
Gunakan salah satu package manager berikut:
bun install
# atau
npm install
# atau
yarn install
# atau
pnpm installbun run devFitur yang aktif:
- Nuxt Hot Module Replacement (HMR)
- Electron auto-restart saat
main.ts/preload.tsberubah
bun run buildares/
├─ 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