How jack000/deepnest works
Project type and purpose
• This is a desktop nesting tool (“Deepnest”) built on Electron.
• It uses a C++ native addon (the Minkowski engine) for speed-critical geometry operations, plus a JavaScript/HTML/CSS frontend (SVGNest-derived) for user interaction and visualization.
File structure
• Top level:
• package.json – project metadata and Electron scripts
• binding.gyp / binding.windowsgyp / binding.gyp mac – build configs for the native C++ addon
• main.js – Electron “main” process entry point
• renderer.js – common logic injected into the renderer
• addon.cc – C++ glue layer exposing the Minkowski engine as a Node module
• “minkowski/” directory:
• Pure C/C++ code + Makefiles + compiled outputs (Release/addon.node) – the fast nesting engine
• “main/” directory:
• HTML (index.html, background.html, login.html), CSS (style.css), background scripts, deepnest.js, svgparser.js – the UI & business logic
• “util/” subfolder – helper libraries (clipper.js, d3-polygon.js, ractive.js, etc.)
README
• Confirms it’s a desktop app for laser-cut nesting.
• Highlights new C engine, DXF support, path approximation.
a. Main components
• Electron Main Process (Node.js + OS integration)
• Renderer Process (BrowserWindow hosting HTML/CSS/JS)
• Native Addon Module (minkowski engine in C/C++)
• File System (SVG/DXF input & export)
• Utility Libraries (clipper, d3-polygon, ractive, etc.)
b. Relationships & interactions
1. User launches app → Electron Main Process
2. Main spawns Renderer (loads index.html + deepnest.js + util)
3. Renderer sends IPC calls to Main for file I/O, menu commands
4. Renderer calls the native addon (require('addon.node')) for heavy geometry (Minkowski sums, nesting)
5. Native addon returns processed geometry back to Renderer
7. Main handles saving/export (SVG/DXF), external commands
c. Architectural patterns & principles
• Multi-process separation (Main vs Renderer) per Electron best practices
• Native addon for CPU-intensive tasks – keeps JS thread responsive
• Modular JS code (util/ helpers, core UI logic in deepnest.js)
• Clear layering: UI ← business logic ← geometry engine
d. Key technologies
• Electron (desktop shell, IPC)
• Node native addons (binding.gyp, C++ addon.cc)
• HTML/CSS/JS (Ractive.js templating, D3, SVG)
• Geometry libs (Clipper, Minkowski C code)
Detail
• Binding.gyp and Makefiles under the native addon area
• IPC channels are annotated (e.g., “ipcMain.on('nest')”)