Robotics academy Desktop App v2

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+out
+.gitignore

.eslintrc.cjs

@@ -0,0 +1,9 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    '@electron-toolkit/eslint-config-ts/recommended',
+    '@electron-toolkit/eslint-config-prettier'
+  ]
+}

.gitignore

@@ -90,4 +90,5 @@ typings/
 
 # Electron-Forge
 out/
-
+old/
+dist/

.prettierignore

@@ -0,0 +1,6 @@
+out
+dist
+pnpm-lock.yaml
+LICENSE.md
+tsconfig.json
+tsconfig.*.json

.prettierrc.yaml

@@ -0,0 +1,4 @@
+singleQuote: true
+semi: false
+printWidth: 100
+trailingComma: none

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "compile-hero.disable-compile-files-on-did-save-code": false
+}

CONTRIBUTING.md

@@ -4,12 +4,13 @@ Welcome to the Robotics Academy Desktop project! We're excited to have you here
 
 ## Table of Contents
 
-1. [Getting Started](#getting-started)
-2. [Development Setup](#development-setup)
-3. [Issues](#issues)
-4. [Contributing Code](#contributing-code)
-5. [Code of Conduct](#code-of-conduct)
-6. [License](#license)
+- [Contributing to Robotics Academy Desktop](#contributing-to-robotics-academy-desktop)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+  - [Development Setup](#development-setup)
+  - [Issues](#issues)
+  - [Contributing Code](#contributing-code)
+  - [Code of Conduct](#code-of-conduct)
 
 ## Getting Started
 
@@ -41,7 +42,7 @@ To set up your development environment and get the Robotics Academy Desktop runn
 5. Start the application:
 
    ```bash
-   npm start
+   npm run dev
    ```
 
 6. Make changes and test your code.

README.md

@@ -1,42 +1,77 @@
-# RoboticsAcademy-Desktop
+<a href="https://jderobot.github.io/"><img src="./resources/logo.gif" width="150" align="right" /></a>
 
-## Table of Contents
+# RoboticsAcademy Desktop: Learn Robotics, Artificial Intelligence and Computer Vision
+
+### Table of Contents
 
 - [About](#about)
-- [Getting Started](#getting-started)
-- [Usage](#usage)
+- [Installation](#installation)
+- [Development](#development)
+- [Build](#build)
+- [Contributing](#build)
 
 ## About
 
-TThe Robotics-Academy Desktop Application is an application used for accessing the Robotics-Academy exercises on any platform, This has been built using Electron.js.
+The Robotics-Academy Desktop Application is an application used for accessing the Robotics-Academy exercises on any platform, This has been built using Electron.js.
+JdeRobot Academy is an open source platform that provides a collection of exercises for learning robotics in a practical way. RoboticsAcademy is completely ROS-based, and includes robotics standard tools like Gazebo and Rviz.
+
+## Installation
+
+### Prerequisites
 
-## Getting Started
+- [Node.js](https://nodejs.org/en)
+- [npm](https://www.npmjs.com/)
 
-TO BUILD AND USE THE APP USE THE FOLLOWING INSTRUCTIONS
+### Steps
 
-Install the packages using :
+1. Clone the repository:
 
-```console
-npm install 
+```
+git clone https://github.com/JdeRobot/RoboticsAcademy-Desktop.git
+cd RoboticsAcademy-Desktop
 ```
 
-Build the electron App using :
+2. Install dependencies
 
-```console
-npm run make
+```
+npm install
+```
+
+3. Run the application
+
+```
+npm run start
 ```
 
-After building a **out** folder will be created. Copy the **run.sh** from the **Script** folder and paste it into **out/electron**
+### Development
 
-Download and Paste the **Robotics-Academy tar.xz**  into **out/electron/roboticsacademy**
+#### Getting Started
 
-## Usage
+To start developing, follow the installation steps above, and then run the app in development mode:
 
-To run the App do the following
+1. Start the app in development mode:
 
 ```
-cd out/electron...
-cd script
-chmod +x run.sh
-./run.sh
+npm run dev
 ```
+
+### Build
+
+- Linux (Ubuntu):
+  After successfully installing the dependencies. Run the
+
+  ```
+  npm run build:linux
+  ```
+
+#### Build Package:
+
+:round_pushpin: After successfully executing the build command, the target build package will be found in the :file_folder: **dist** folder.
+
+:warning: You may need to install build dependencies for target package. [Learn more](https://www.electronjs.org/docs/latest/development/build-instructions-linux)
+
+:black_nib: You can configure builder as your need. See [electron-builder.yml](./electron-builder.yml) file.
+
+### Contributing
+
+Take a look at the [contributing](./CONTRIBUTING.md) guide lines.

build/entitlements.mac.plist

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
+    <true/>
+  </dict>
+</plist>

dev-app-update.yml

@@ -0,0 +1,3 @@
+provider: generic
+url: https://example.com/auto-updates
+updaterCacheDirName: roboticsacademy-updater

electron-builder.yml

@@ -0,0 +1,72 @@
+appId: com.roboticsacademy.app
+productName: RoboticsAcademy
+directories:
+  buildResources: build
+
+buildDependenciesFromSource: true
+
+extraResources:
+  - './splashscreen.html'
+  - 'resources/**'
+  - './roboticsacademy.db'
+files:
+  - '!**/.vscode/*'
+  - '!src/*'
+  - '!electron.vite.config.{js,ts,mjs,cjs}'
+  - '!{.eslintignore,.eslintrc.cjs,.prettierignore,.prettierrc.yaml,dev-app-update.yml,CHANGELOG.md,README.md}'
+  - '!{.env,.env.*,.npmrc,pnpm-lock.yaml}'
+  - '!{tsconfig.json,tsconfig.node.json,tsconfig.web.json}'
+asarUnpack:
+  - resources/**
+win:
+  executableName: RoboticsAcademy
+  requestedExecutionLevel: requireAdministrator
+  target:
+    - nsis
+  icon: resources/icons/icon.ico
+nsis:
+  artifactName: ${name}-${version}-setup.${ext}
+  shortcutName: ${productName}
+  uninstallDisplayName: ${productName}
+  installerLanguages:
+    - en
+    - es
+  createDesktopShortcut: true
+  displayLanguageSelector: true
+  createStartMenuShortcut: true
+  allowToChangeInstallationDirectory: true
+  oneClick: false
+  perMachine: false
+  installerIcon: resources/icons/icon.ico
+  uninstallerIcon: resources/icons/icon.ico
+  installerHeaderIcon: resources/icons/icon.ico
+  license: license/license_en_US.txt
+
+mac:
+  entitlementsInherit: build/entitlements.mac.plist
+  extendInfo:
+    - NSCameraUsageDescription: Application requests access to the device's camera.
+    - NSMicrophoneUsageDescription: Application requests access to the device's microphone.
+    - NSDocumentsFolderUsageDescription: Application requests access to the user's Documents folder.
+    - NSDownloadsFolderUsageDescription: Application requests access to the user's Downloads folder.
+  notarize: false
+dmg:
+  artifactName: ${name}-${version}.${ext}
+linux:
+  icon: resources/icons/icon.icns
+  desktop:
+    Type: 'Application'
+    Encoding: 'UTF-8'
+    Name: 'Robotics Academy'
+  target:
+    - deb
+  maintainer: https://jderobot.github.io/RoboticsAcademy/
+  category: Utility
+appImage:
+  artifactName: ${name}-${version}.${ext}
+npmRebuild: false
+publish:
+  provider: generic
+  url:
+electronDownload:
+  mirror:

electron.vite.config.1723371720494.mjs

@@ -0,0 +1,23 @@
+// electron.vite.config.ts
+import { resolve } from "path";
+import { defineConfig, externalizeDepsPlugin } from "electron-vite";
+import react from "@vitejs/plugin-react";
+var electron_vite_config_default = defineConfig({
+  main: {
+    plugins: [externalizeDepsPlugin()]
+  },
+  preload: {
+    plugins: [externalizeDepsPlugin()]
+  },
+  renderer: {
+    resolve: {
+      alias: {
+        "@renderer": resolve("src/renderer/src")
+      }
+    },
+    plugins: [react()]
+  }
+});
+export {
+  electron_vite_config_default as default
+};

electron.vite.config.1724091239149.mjs

@@ -0,0 +1,23 @@
+// electron.vite.config.ts
+import { resolve } from "path";
+import { defineConfig, externalizeDepsPlugin } from "electron-vite";
+import react from "@vitejs/plugin-react";
+var electron_vite_config_default = defineConfig({
+  main: {
+    plugins: [externalizeDepsPlugin()]
+  },
+  preload: {
+    plugins: [externalizeDepsPlugin()]
+  },
+  renderer: {
+    resolve: {
+      alias: {
+        "@renderer": resolve("src/renderer/src")
+      }
+    },
+    plugins: [react()]
+  }
+});
+export {
+  electron_vite_config_default as default
+};

electron.vite.config.ts

@@ -0,0 +1,20 @@
+import { resolve } from 'path'
+import { defineConfig, externalizeDepsPlugin } from 'electron-vite'
+import react from '@vitejs/plugin-react'
+
+export default defineConfig({
+  main: {
+    plugins: [externalizeDepsPlugin()]
+  },
+  preload: {
+    plugins: [externalizeDepsPlugin()]
+  },
+  renderer: {
+    resolve: {
+      alias: {
+        '@renderer': resolve('src/renderer/src')
+      }
+    },
+    plugins: [react()]
+  }
+})

license/license_en_US.txt

@@ -0,0 +1 @@
+Welcome to Robotics Academy!