Release: JSCircuit v1.1.0

Merge develop into main for production release.

New Features:
- Clipboard export netlist (Ctrl+Shift+C)
- Zero external dependencies (configuration embedded)
- Improved component label rendering

Improvements:
- Reduced font sizes for better circuit clarity
- Standardized element naming conventions
- Enhanced documentation with getting started guide
- Better error handling and DOM cleanup

Bug Fixes:
- Fixed GitHub Pages asset paths
- Improved clipboard operation error handling

All 448 tests passing. Ready for production.

Author: jurra

.github/workflows/deploy.yml

@@ -0,0 +1,60 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch: # Allows manual triggering
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Checkout the repository
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    # Set up Node.js
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: 'npm'
+
+    # Install dependencies
+    - name: Install dependencies
+      run: npm ci
+
+    # Build documentation
+    - name: Build documentation
+      run: npm run docs:build
+
+    # Upload artifact for GitHub Pages
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+    branches:
+      - develop
+      - main
+  workflow_dispatch: # Allows manual triggering
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Checkout the repository
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    # Set up Node.js
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20' # Updated to Node.js 20 LTS for better compatibility
+        cache: 'npm' # Cache npm dependencies for faster builds
+
+    # Install dependencies
+    - name: Install dependencies
+      run: npm ci # Use npm ci for faster, reliable builds in CI
+
+    # Build menu configuration (required for tests)
+    - name: Build menu configuration
+      run: npm run menu:build
+
+    # Run tests
+    - name: Run tests
+      run: npm test

.gitignore

@@ -1,5 +1,16 @@
 dev-notes
 .trunk
+.ipynb_checkpoints/
+.vscode/
 
 # ignore node dependencies
-node_modules
+node_modules
+
+# Ignored build files
+dist/
+docs/dist/
+
+# Auto-generated configuration (built from gui.config.yaml)
+src/config/gui.config.js
+
+compile.txt

CITATION.cff

@@ -0,0 +1,28 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "JSCircuit - Web-based Circuit Editor and Netlist Generator"
+abstract: "A web-based circuit editor for designing circuits and exporting netlists to various formats. Built with modern JavaScript, featuring real-time rendering, spatial indexing optimization, and support for multiple circuit types including cavity circuits, couplers, and optomechanical systems."
+authors:
+  - family-names: "Urra Llanusa"
+    given-names: "Jose Carlos"
+    email: "j.c.urrallanusa@tudelft.nl"
+    affiliation: "Delft University of Technology"
+contributors:
+  - family-names: "Steele"
+    given-names: "Gary"
+  - family-names: "Branchet"
+    given-names: "Susan"
+version: "1.1.0"
+date-released: "2025-01-15"
+license: "MIT"
+repository-code: "https://github.com/qucat/jscircuit"
+repository: "https://github.com/qucat/jscircuit"
+keywords:
+  - "circuit editor"
+  - "netlist generation"
+  - "web application"
+  - "quantum circuits"
+  - "circuit design"
+  - "interactive visualization"
+  - "JavaScript"
+documentation: "https://github.com/qucat/jscircuit/blob/main/README.md"