GGcode Compiler

A modern web-based compiler for GGcode to G-code conversion with 3D visualization, real-time editing, and comprehensive tooling support.

🚀 Features test

Real-time GGcode Compilation: Convert GGcode to standard G-code with live feedback
Monaco Editor Integration: Advanced code editing with syntax highlighting and IntelliSense
3D G-code Visualization: Interactive 3D preview of toolpaths with simulation controls
Configurator System: Dynamic form generation for parameterized GGcode files
Examples Library: Built-in collection of GGcode examples and templates
Help System: Comprehensive documentation with multi-language support
File Operations: Import/export GGcode and G-code files with drag-and-drop support
Annotation System: Real-time G-code analysis with modal state tracking

📁 Project Structure

├── .githooks/
│   ├── commit-msg
│   ├── post-commit
│   └── pre-commit
├── .github/ # GitHub workflows
│   ├── workflows/
│   │   ├── ci.yml
│   │   ├── documentation.yml
│   │   └── release.yml
│   └── markdown-link-check-config.json
├── docs/ # Documentation
│   ├── AI_AGENT_DOCUMENTATION.md
│   ├── ARCHITECTURE.md
│   ├── BUILD_DOCUMENTATION.md
│   ├── COMMANDS.md
│   ├── DEPLOYMENT.md
│   ├── LOCALSTORAGE_LOGIC.md
│   ├── PROJECT_STRUCTURE.md
│   └── SVG_Path_Commands.md
├── GGCODE/ # Example files
│   ├── advanced patterns.ggcode
│   ├── advanced_control.ggcode
│   ├── Arc Spiral Pattern.ggcode
│   ├── array_example.ggcode
│   ├── array_literals.ggcode
│   ├── Base10_Dice.ggcode
│   ├── base10_Digits.ggcode
│   ├── Basic Arc Commands.ggcode
│   ├── Basic Square Pocket.ggcode
│   ├── basic_circle.ggcode
│   ├── complete_features.ggcode
│   ├── complete_math.ggcode
│   ├── configurator_demo.ggcode
│   ├── Crop Circle Pattern.ggcode
│   ├── Flower of Life.ggcode
│   ├── Flower Pattern with Arcs.ggcode
│   ├── function_example.ggcode
│   ├── Gear Teeth.ggcode
│   ├── Inverted Spiral - Downward.ggcode
│   ├── math_functions.ggcode
│   ├── Mind-Blowing Gear Generator.ggcode
│   ├── operators_and_logic.ggcode
│   ├── Rose Pattern.ggcode
│   ├── simple_spiral.ggcode
│   ├── Spiral Function Circle Grid.ggcode
│   ├── Spiral Function Grid.ggcode
│   ├── Spiral Function Multi-Ring Circular Grid.ggcode
│   ├── Spiral.ggcode
│   ├── square.ggcode
│   ├── Stair Stringer.ggcode
│   ├── star.ggcode
│   ├── start spiral.ggcode
│   ├── SVG.ggcode
│   ├── test-arc.ggcode
│   ├── test-svg-arcs.ggcode
│   └── True Spiral with Arcs.ggcode
├── public/ # Static assets (legacy)
│   ├── css/
│   │   ├── components/
│   │   │   ├── buttons.css
│   │   │   ├── controls.css
│   │   │   ├── headers.css
│   │   │   ├── navigation.css
│   │   │   └── tooltips.css
│   │   ├── editor/
│   │   │   ├── annotation-content.css
│   │   │   ├── annotation-toolbar.css
│   │   │   └── annotations.css
│   │   ├── layout/
│   │   │   ├── global.css
│   │   │   ├── grid.css
│   │   │   └── panels.css
│   │   ├── modals/
│   │   │   ├── app-usage.css
│   │   │   ├── base.css
│   │   │   ├── code-blocks.css
│   │   │   ├── collapsible.css
│   │   │   ├── dropdowns.css
│   │   │   ├── examples.css
│   │   │   ├── help-system.css
│   │   │   ├── language-selector.css
│   │   │   ├── rtl-support.css
│   │   │   ├── search.css
│   │   │   ├── settings.css
│   │   │   └── states.css
│   │   ├── base.css
│   │   ├── components.css
│   │   ├── editor.css
│   │   ├── main.css
│   │   ├── modals.css
│   │   └── README.md
│   ├── data/
│   │   ├── completions/
│   │   │   ├── ggcode-axes.json
│   │   │   ├── ggcode-brackets.json
│   │   │   ├── ggcode-constants.json
│   │   │   ├── ggcode-functions.json
│   │   │   ├── ggcode-hover-constants.json
│   │   │   ├── ggcode-hover-functions.json
│   │   │   ├── ggcode-hover-gcodes.json
│   │   │   ├── ggcode-hover-keywords.json
│   │   │   ├── ggcode-hover-mcodes.json
│   │   │   ├── ggcode-keywords.json
│   │   │   ├── ggcode-language-config.json
│   │   │   ├── ggcode-operators.json
│   │   │   ├── ggcode-param-mappings.json
│   │   │   ├── ggcode-signatures.json
│   │   │   └── ggcode-tokenizer.json
│   │   ├── help-content/
│   │   │   ├── ar.json
│   │   │   ├── de.json
│   │   │   ├── en.json
│   │   │   ├── es.json
│   │   │   ├── fr.json
│   │   │   ├── he.json
│   │   │   ├── it.json
│   │   │   ├── ja.json
│   │   │   ├── ko.json
│   │   │   ├── metadata.json
│   │   │   ├── MULTILANGUAGE_GUIDE.md
│   │   │   ├── nl.json
│   │   │   ├── pl.json
│   │   │   ├── pt.json
│   │   │   ├── README.md
│   │   │   ├── ru.json
│   │   │   ├── tr.json
│   │   │   └── zh.json
│   │   ├── themes/
│   │   │   ├── ggcode-dark-colors.json
│   │   │   └── ggcode-light-colors.json
│   │   └── team-themes.json
│   ├── js/
│   │   ├── main.js
│   │   ├── main.js.LICENSE.txt
│   │   ├── main.js.map
│   │   ├── navigation.js
│   │   ├── navigation.js.map
│   │   ├── src_client_js_core_applicationManager_js.js
│   │   ├── src_client_js_core_applicationManager_js.js.map
│   │   ├── src_client_js_editor_settings_js.js
│   │   ├── src_client_js_editor_settings_js.js.map
│   │   ├── src_client_js_editor_theme-loader_js.js
│   │   ├── src_client_js_editor_theme-loader_js.js.map
│   │   ├── src_client_js_editor_themes_js.js
│   │   ├── src_client_js_editor_themes_js.js.map
│   │   ├── src_client_js_ui_aiCommands_js.js
│   │   └── src_client_js_ui_aiCommands_js.js.map
│   ├── flags.css
│   ├── GGcode.ico
│   ├── logo.png
│   ├── mill-annotations.json
│   ├── mill-dictionary.json
│   ├── OrbitControls.js
│   └── style.css
├── scripts/ # Build and utility scripts
│   ├── check-project-health.sh
│   ├── generate-docs.sh
│   ├── setup-hooks.sh
│   ├── smart-commit.sh
│   ├── update-changelog.js
│   ├── update-dependencies.sh
│   ├── update-readme-structure.js
│   └── verify-setup.sh
├── src/ # Source code
│   ├── client/ # Client-side code (ES6 modules)
│   │   └── js/
│   │       ├── api/
│   │       ├── config/
│   │       ├── configurator/
│   │       ├── core/
│   │       ├── editor/
│   │       ├── ui/
│   │       ├── utils/
│   │       ├── visualizer/
│   │       └── main.js
│   └── server/ # Server-side code (CommonJS)
│       ├── config/
│       │   ├── environment.js
│       │   └── index.js
│       ├── middleware/
│       │   ├── errorHandler.js
│       │   ├── index.js
│       │   └── security.js
│       ├── routes/
│       │   ├── ai.js
│       │   ├── compiler.js
│       │   ├── examples.js
│       │   ├── help.js
│       │   └── index.js
│       ├── services/
│       │   ├── compiler.js
│       │   ├── fileManager.js
│       │   └── helpContent.js
│       ├── app.js
│       └── index.js
├── tests/ # Test suite
│   ├── client/
│   │   ├── api/
│   │   │   ├── client.test.js
│   │   │   └── compiler.test.js
│   │   └── visualizer/
│   │       ├── adaptive-rendering.test.js
│   │       ├── chunk-loader.test.js
│   │       ├── debug.test.js
│   │       ├── frustum-culling-performance.test.js
│   │       ├── frustum-culling.test.js
│   │       ├── geometry-manager.test.js
│   │       ├── geometry-optimization.test.js
│   │       ├── lod-system.test.js
│   │       ├── matrix-calculations.test.js
│   │       ├── parser-simple.test.js
│   │       ├── PERFORMANCE_VALIDATION_SUMMARY.md
│   │       ├── performance-test-report.md
│   │       ├── progress-bar-benchmark.js
│   │       ├── progress-bar-integration.test.js
│   │       ├── progress-bar-validation.js
│   │       ├── render-queue.test.js
│   │       ├── renderer-optimization.test.js
│   │       ├── renderer.test.js
│   │       └── tooltipIntegration.test.js
│   ├── config/
│   │   └── testConfig.js
│   ├── fixtures/
│   │   ├── examples/
│   │   │   ├── simple_square.ggcode
│   │   │   └── with_variables.ggcode
│   │   └── help/
│   │       └── test_help.json
│   ├── server/
│   │   ├── config/
│   │   │   └── config.test.js
│   │   └── services/
│   │       ├── compiler.test.js
│   │       └── fileManager.test.js
│   ├── utils/
│   │   ├── mocks.js
│   │   ├── testHelpers.js
│   │   └── testRunner.js
│   ├── AI_TESTING_README.md
│   ├── ai-commands-test.js
│   ├── ai-integration-results.json
│   ├── ai-integration-test.js
│   ├── ai-test-cases.json
│   ├── run-ai-tests.js
│   ├── setup.js
│   └── smoke-tests.json
├── views/ # EJS templates
│   ├── layouts/
│   │   └── main.ejs
│   ├── pages/
│   │   └── index.ejs
│   ├── partials/
│   │   ├── head.ejs
│   │   ├── modals.ejs
│   │   ├── scripts.ejs
│   │   └── viewer.ejs
│   ├── help-template.ejs
│   ├── helpExamples.ejs
│   └── index.ejs
├──  pm2.json
├── .eslintrc.js
├── .gitignore
├── .jsdoc.json
├── .prettierrc
├── CHANGELOG.md
├── CONTRIBUTING.md
├── libggcode.so
├── MAINTENANCE.md
├── nodemon.json
├── nohup.out
├── package-lock.json
├── package.json
├── README.md
├── server.log
├── setup.sh
├── USAGE.md
└── webpack.config.js

🛠️ Installation

Prerequisites

Node.js >= 16.0.0
npm >= 8.0.0
GGcode native library (libggcode.so)

Setup

Clone the repository

git clone <repository-url>
cd ggcode-compiler

Install dependencies
```
npm install
```

Configure environment

cp .env.example .env
# Edit .env with your configuration

Build and test
```
npm run build
```

🚀 Usage

Development

# Start development server with hot reload
npm run dev

# Start with debugging
npm run dev:watch

Production

# Start production server
npm start

# Or with PM2
pm2 start ecosystem.config.js

Testing

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests in watch mode
npm run test:watch

Code Quality

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix

# Format code
npm run format

# Check formatting
npm run format:check

Documentation Automation

# Update project structure in README.md
npm run update-structure

# Add changelog entry from recent commits
npm run update-changelog        # Uses version from package.json
npm run update-changelog 1.0.2  # Uses specific version

These simple scripts automate the mechanical parts of documentation maintenance:

Project Structure: Scans directories and updates the ## 📁 Project Structure section
Changelog: Extracts git commits since last tag and adds formatted entries to CHANGELOG.md

Run these manually when preparing releases or updating documentation. The scripts handle the boring stuff while leaving creative content for manual editing.

📚 API Documentation

Compilation Endpoints

POST /api/compile - Compile GGcode to G-code
POST /api/validate - Validate GGcode syntax
GET /api/compiler/status - Get compiler status

Examples Endpoints

GET /api/examples - List available examples
GET /api/examples/:filename - Get specific example

Help Endpoints

GET /api/help - Get help content
GET /api/help/:section - Get specific help section

🏗️ Architecture

Client-Side Architecture

The client uses a modular ES6 architecture with the following key components:

Monaco Editor Manager: Handles code editing with syntax highlighting
API Manager: Centralized API communication
Configurator Manager: Dynamic form generation and validation
Annotation System: Real-time G-code analysis
Modal Manager: UI modal management
File Operations: Import/export functionality

Server-Side Architecture

The server follows a layered architecture:

Routes Layer: Express route handlers
Services Layer: Business logic and data processing
Middleware Layer: Request processing and security
Configuration Layer: Environment and application settings

Module System

Client: ES6 modules for modern browser compatibility
Server: CommonJS modules for Node.js compatibility
Backward Compatibility: Global function exports for legacy HTML

🔧 Configuration

Environment Variables

NODE_ENV=development|production|test
PORT=6990
HOST=localhost
COMPILER_LIB_PATH=/path/to/libggcode.so

Application Configuration

Configuration is managed through environment-specific files in src/server/config/:

environment.js - Environment-specific settings
index.js - Configuration manager

🧪 Testing Strategy

Test Structure

Unit Tests: Individual component testing
Integration Tests: API endpoint testing
Client Tests: Browser-based component testing
Coverage: Comprehensive code coverage reporting

Test Commands

npm test              # Run all tests
npm run test:watch    # Watch mode
npm run test:coverage # With coverage report

📈 Performance

Optimization Features

Lazy Loading: Dynamic module loading
Code Splitting: Separate bundles for different features
Caching: Static asset caching in production
Compression: Gzip compression for responses
Rate Limiting: API rate limiting for security

Monitoring

Health Checks: /api/health endpoint
Error Tracking: Comprehensive error logging
Performance Metrics: Request timing and resource usage

🔒 Security

Security Features

Input Validation: Comprehensive input sanitization
Rate Limiting: Protection against abuse
Security Headers: CSRF, XSS, and clickjacking protection
Content Security Policy: Strict CSP implementation
Error Handling: Secure error responses

🤝 Contributing

Development Workflow

Fork the repository

Create a feature branch

git checkout -b feature/your-feature-name

Make changes and test
```
npm run build
npm test
```
Commit with conventional commits
```
git commit -m "feat: add new feature"
```
Push and create PR

Code Standards

ESLint: Code linting with custom rules
Prettier: Code formatting
Conventional Commits: Standardized commit messages
Test Coverage: Maintain >80% coverage

📄 License

ISC License - see LICENSE file for details

🆘 Support

Documentation

API Docs: Available at /api/docs when running
Help System: Built-in help at /help
Examples: Sample files in /examples

Troubleshooting

Common issues and solutions:

Compilation Errors: Check libggcode.so path and permissions
Port Conflicts: Change PORT in environment variables
Module Errors: Ensure Node.js version >= 16.0.0

Getting Help

Issues: GitHub Issues for bug reports
Discussions: GitHub Discussions for questions
Documentation: In-app help system

Version History

v1.0.0: Initial modular architecture implementation
v0.9.x: Legacy monolithic structure

Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
.githooks		.githooks
.github		.github
GGCODE		GGCODE
docs		docs
public		public
scripts		scripts
src		src
tests		tests
views		views
pm2.json		pm2.json
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.jsdoc.json		.jsdoc.json
.prettierrc		.prettierrc
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
MAINTENANCE.md		MAINTENANCE.md
README.md		README.md
USAGE.md		USAGE.md
nodemon.json		nodemon.json
nohup.out		nohup.out
package-lock.json		package-lock.json
package.json		package.json
setup.sh		setup.sh
webpack.config.js		webpack.config.js

1T17/GGcode-node

Folders and files

Latest commit

History

Repository files navigation