Developer Guide

Info

This section provides comprehensive developer documentation for the eIsland project, covering environment setup, development workflows, coding standards, and testing practices.

Documentation Structure

Environment Setup

Environment configuration for frontend, backend, and plugin development.

Document	Description
Frontend Setup	Node.js, npm, Electron, React, and frontend IDE configuration
Backend Setup	Java JDK, Maven, MySQL, Redis, RabbitMQ, and backend IDE configuration
Plugin Setup	Plugin development toolchain, scaffolding, and testing environment

Git Operations

Git workflows and commands for eIsland development.

Document	Description
Local Operations	Local Git commands: branching, committing, rebasing, and history management
GitHub Operations	GitHub workflows: pull requests, code reviews, issue management, and CI/CD

Development Commands

Detailed reference for npm scripts defined in package.json.

Document	Description
Development Commands	dev, build, preview — building, running, and previewing the application
Testing Commands	test, test:preload, test:coverage — running tests and measuring coverage
Package Commands	package, postinstall — building installers and managing native modules
Code Quality Commands	comment:check, i18n:check — validating comment standards and i18n completeness
Release Commands	release:notes, changelog:generate, release:upload* — changelogs and artifact uploads
Plugin Commands	build, test, smoke — building, testing, and smoke-testing all native plugins

Code Quality

Coding standards and comment quality requirements for the eIsland project.

Document	Description
Code Quality Review	Frontend coding standards covering HTML, CSS, JavaScript, TypeScript, React, and Next.js conventions
Comment Quality Review	JSDoc comment standards, file headers, function documentation, and annotation best practices