Initial commit

Author: lrusso

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/pages/ArduinoEditor.js

@@ -0,0 +1,22 @@
+{
+  "name": "Arduino Simulator",
+  "short_name": "Arduino Simulator",
+  "lang": "en-US",
+  "start_url": "https://lrusso.github.io/ArduinoSimulator/index.html",
+  "display": "standalone",
+  "orientation": "portrait",
+  "theme_color": "#F2F2F2",
+  "background_color": "#000000",
+  "icons": [
+    {
+      "src": "https://lrusso.github.io/ArduinoSimulator/ArduinoSimulatorFavIcon_192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "https://lrusso.github.io/ArduinoSimulator/ArduinoSimulatorFavIcon_512x512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ]
+}

.github/pages/ArduinoSimulator.js

@@ -0,0 +1,35 @@
+const filesToCache = [
+  "ArduinoEditor.js",
+  "ArduinoSimulator.json",
+  "ArduinoSimulator.svg",
+  "ArduinoSimulatorFavIcon_192x192.png",
+  "ArduinoSimulatorFavIcon_512x512.png",
+  "ArduinoSimulatorInterpreter.min.js",
+  "index.html",
+]
+
+const staticCacheName = "ArduinoSimulator-v1"
+
+// eslint-disable-next-line no-restricted-globals
+self.addEventListener("install", (event) => {
+  event.waitUntil(
+    caches.open(staticCacheName).then((cache) => {
+      return cache.addAll(filesToCache)
+    })
+  )
+})
+
+// eslint-disable-next-line no-restricted-globals
+self.addEventListener("fetch", (event) => {
+  event.respondWith(
+    caches
+      .match(event.request)
+      .then((response) => {
+        if (response) {
+          return response
+        }
+        return fetch(event.request)
+      })
+      .catch(() => {})
+  )
+})

.github/pages/ArduinoSimulator.json

@@ -0,0 +1,41 @@
+name: "Continuous Deployment"
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - .github/pages/**
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "continuous-deployment"
+  cancel-in-progress: true
+
+jobs:
+  continuous-deployment:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./.github/pages
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/pages/ArduinoSimulator.svg

@@ -0,0 +1,45 @@
+name: "Continuous Integration"
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - README.md
+      - .github/pages/**
+
+concurrency:
+  group: "continuous-integration"
+  cancel-in-progress: true
+
+jobs:
+  continuous-integration:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+      - name: Installing packages
+        run: npm install
+      - name: Starting the Arduino Simulator Web App in Pipeline mode
+        run: npm run start:pipeline
+      - name: Building the Arduino Simulator Web App
+        run: npm run build
+      - name: Checking Prettier Rules
+        run: npm run prettier
+      - name: Checking Lint Rules
+        run: npm run lint
+      - name: Running Dependency Tests
+        run: npm run test:dependency
+      - name: Running Benchmark Tests
+        run: npm run test:benchmark
+      - name: Running Unit Tests
+        run: npm run test:unit
+      - name: Running End-To-End Tests
+        run: npm run test:e2e
+      - name: Attaching the Arduino Simulator Web App to this workflow
+        uses: actions/upload-artifact@v3
+        with:
+          name: arduino-simulator-web-app
+          path: build

.github/pages/ArduinoSimulatorFavIcon_16x16.png

@@ -0,0 +1,11 @@
+# dependencies
+*node_modules
+
+# build folder
+*build
+
+# misc
+.DS_Store
+
+# logs
+npm-debug.log*

.github/pages/ArduinoSimulatorFavIcon_192x192.png

@@ -0,0 +1,15 @@
+build
+.github/pages/ArduinoEditor.js
+.github/pages/ArduinoSimulator.js
+.github/pages/ArduinoSimulatorInterpreter.js
+.github/pages/ArduinoSimulatorInterpreter.min.js
+.github\pages\ArduinoEditor.js
+.github\pages\ArduinoSimulator.js
+.github\pages\ArduinoSimulatorInterpreter.js
+.github\pages\ArduinoSimulatorInterpreter.min.js
+public/ArduinoEditor.js
+public/ArduinoSimulatorInterpreter.js
+public/ArduinoSimulatorInterpreter.min.js
+public\ArduinoEditor.js
+public\ArduinoSimulatorInterpreter.js
+public\ArduinoSimulatorInterpreter.min.js

.github/pages/ArduinoSimulatorFavIcon_512x512.png

@@ -1 +1,31 @@
-# ArduinoSimulator
+# Arduino Simulator
+
+Arduino Simulator in JavaScript.
+
+![alt screenshot](https://raw.githubusercontent.com/lrusso/ArduinoSimulator/master/README.png)
+
+## Web:
+
+https://lrusso.github.io/ArduinoSimulator
+
+## Demo using digital and analog pins:
+
+https://lrusso.github.io/ArduinoSimulator/demo1.html
+
+## Demo using the Serial monitor:
+
+https://lrusso.github.io/ArduinoSimulator/demo2.html
+
+## Demo using the EEPROM (work in progress):
+
+https://lrusso.github.io/ArduinoSimulator/demo3.html
+
+## How to set a default sketch in the simulator?
+
+Create the JavaScript `DEFAULT_SKETCH` variable with your Sketch and put it in the HTML file, like it was done in the `demo1.html` file.
+
+## Deploying the project
+
+- Build the Web App and place the files in the `.github/pages` folder.
+- Commit and push the changes to the main branch.
+- A workflow will be triggered that will publish those changes.