code updates

code updates

Author: code-forge-temple

.github/workflows/main.yml

@@ -0,0 +1,57 @@
+name: Deploy circuit-sketcher-app
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write  # Allows actions to push to the repository (required for gh-pages)
+  pages: write    # Allows actions to deploy to GitHub Pages
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Step 1: Checkout the code
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Node.js using .nvmrc
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+
+      # Step 3: Install dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Step 4: Build the project
+      - name: Build project
+        run: npm run build
+
+      # Step 5: Upload production-ready build files (artifact)
+      - name: Upload production-ready build files
+        uses: actions/upload-artifact@v3
+        with:
+          name: production-files
+          path: ./dist
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      # Step 1: Download artifact
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: production-files
+          path: ./dist
+
+      # Step 2: Deploy to GitHub Pages
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

.nvmrc

@@ -0,0 +1 @@
+v23.3.0

README.md

@@ -1,2 +1,84 @@
 # circuit-sketcher-app
 An application to draw circuits on a canvas, based on circuit-sketcher-core.
+
+## Table of Contents
+
+- [Features](#features)
+- [Development](#development)
+  - [Installation](#installation)
+  - [Building](#building)
+  - [Linting](#linting)
+  - [Preview](#preview)
+  - [Usage](#usage)
+- [Demo](#demo)
+- [License](#license)
+
+## Features
+
+- Draw and save circuit diagrams
+- Load and save canvas and library data
+- Save to Local Storage Library the customized circuit nodes
+- Responsive design
+- Interactive user interface
+
+## Development
+
+### Installation
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/code-forge-temple/circuit-sketcher-app.git
+    cd circuit-sketcher-app
+    ```
+
+2. Set the Node.js version:
+    - For Unix-based systems:
+        ```sh
+        nvm use
+        ```
+    - For Windows:
+        ```sh
+        nvm use $(cat .nvmrc)
+        ```
+
+3. Install dependencies:
+    ```sh
+    npm install
+    ```
+
+4. Start the development server:
+    ```sh
+    npm run dev
+    ```
+
+### Building
+
+To build the project for production, run:
+```sh
+npm run build
+```
+
+### Linting
+To lint the project, run:
+```sh
+npm run lint
+```
+
+### Preview
+To preview the production build, run:
+```sh
+npm run preview
+```
+
+### Usage
+
+1. Open the application in your browser.
+2. Use the toolbar to draw and manipulate circuit elements.
+3. Save your work using the save buttons.
+4. Load previously saved canvases and libraries using the load buttons.
+
+## Demo
+You can view the deployed version of the application [here](https://code-forge-temple.github.io/circuit-sketcher-app).
+
+## License
+This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details.

eslint.config.mjs

@@ -0,0 +1,38 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+        ecmaVersion: 2020,
+        globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+      'max-len': ['error', { code: 180 }],
+      'indent': ['error', 4, { "SwitchCase": 1 }],
+      '@typescript-eslint/no-explicit-any': 'off',
+      'no-trailing-spaces': 'error', // Disallow trailing spaces
+      'no-multi-spaces': 'error', // Disallow multiple spaces
+      'no-irregular-whitespace': 'error', // Disallow irregular whitespace
+      'space-in-parens': ['error', 'never'], // Enforce spacing inside parentheses
+      'space-before-function-paren': ['error', 'always'], // Enforce spacing before function parenthesis
+      'comma-spacing': ['error', { before: false, after: true }], // Enforce spacing after commas
+      'object-curly-spacing': ['error', 'never'], // Enforce spacing inside curly braces
+    },
+  },
+)

index.html

@@ -0,0 +1,16 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <link rel="icon" type="image/x-icon" href="/logo.ico" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Circuit Sketcher</title>
+</head>
+
+<body>
+  <div id="root"></div>
+  <script type="module" src="/src/main.tsx"></script>
+</body>
+
+</html>