Skip to content

Commit cc5dfca

Browse files
codezerrocodezerro
authored
Robotics academy Desktop App v2 (#16)
1 parent 4121e1f commit cc5dfca

108 files changed

Lines changed: 21864 additions & 6136 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

‎.eslintignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
dist
3+
out
4+
.gitignore

‎.eslintrc.cjs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = {
2+
extends: [
3+
'eslint:recommended',
4+
'plugin:react/recommended',
5+
'plugin:react/jsx-runtime',
6+
'@electron-toolkit/eslint-config-ts/recommended',
7+
'@electron-toolkit/eslint-config-prettier'
8+
]
9+
}

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,5 @@ typings/
9090

9191
# Electron-Forge
9292
out/
93-
93+
old/
94+
dist/

‎.prettierignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
out
2+
dist
3+
pnpm-lock.yaml
4+
LICENSE.md
5+
tsconfig.json
6+
tsconfig.*.json

‎.prettierrc.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singleQuote: true
2+
semi: false
3+
printWidth: 100
4+
trailingComma: none

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"compile-hero.disable-compile-files-on-did-save-code": false
3+
}

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ Welcome to the Robotics Academy Desktop project! We're excited to have you here
44

55
## Table of Contents
66

7-
1. [Getting Started](#getting-started)
8-
2. [Development Setup](#development-setup)
9-
3. [Issues](#issues)
10-
4. [Contributing Code](#contributing-code)
11-
5. [Code of Conduct](#code-of-conduct)
12-
6. [License](#license)
7+
- [Contributing to Robotics Academy Desktop](#contributing-to-robotics-academy-desktop)
8+
- [Table of Contents](#table-of-contents)
9+
- [Getting Started](#getting-started)
10+
- [Development Setup](#development-setup)
11+
- [Issues](#issues)
12+
- [Contributing Code](#contributing-code)
13+
- [Code of Conduct](#code-of-conduct)
1314

1415
## Getting Started
1516

@@ -41,7 +42,7 @@ To set up your development environment and get the Robotics Academy Desktop runn
4142
5. Start the application:
4243

4344
```bash
44-
npm start
45+
npm run dev
4546
```
4647

4748
6. Make changes and test your code.

‎README.md‎

Lines changed: 56 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,77 @@
1-
# RoboticsAcademy-Desktop
1+
<a href="https://jderobot.github.io/"><img src="./resources/logo.gif" width="150" align="right" /></a>
22

3-
## Table of Contents
3+
# RoboticsAcademy Desktop: Learn Robotics, Artificial Intelligence and Computer Vision
4+
5+
### Table of Contents
46

57
- [About](#about)
6-
- [Getting Started](#getting-started)
7-
- [Usage](#usage)
8+
- [Installation](#installation)
9+
- [Development](#development)
10+
- [Build](#build)
11+
- [Contributing](#build)
812

913
## About
1014

11-
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.
15+
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.
16+
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.
17+
18+
## Installation
19+
20+
### Prerequisites
1221

13-
## Getting Started
22+
- [Node.js](https://nodejs.org/en)
23+
- [npm](https://www.npmjs.com/)
1424

15-
TO BUILD AND USE THE APP USE THE FOLLOWING INSTRUCTIONS
25+
### Steps
1626

17-
Install the packages using :
27+
1. Clone the repository:
1828

19-
```console
20-
npm install
29+
```
30+
git clone https://github.com/JdeRobot/RoboticsAcademy-Desktop.git
31+
cd RoboticsAcademy-Desktop
2132
```
2233

23-
Build the electron App using :
34+
2. Install dependencies
2435

25-
```console
26-
npm run make
36+
```
37+
npm install
38+
```
39+
40+
3. Run the application
41+
42+
```
43+
npm run start
2744
```
2845

29-
After building a **out** folder will be created. Copy the **run.sh** from the **Script** folder and paste it into **out/electron**
46+
### Development
3047

31-
Download and Paste the **Robotics-Academy tar.xz** into **out/electron/roboticsacademy**
48+
#### Getting Started
3249

33-
## Usage
50+
To start developing, follow the installation steps above, and then run the app in development mode:
3451

35-
To run the App do the following
52+
1. Start the app in development mode:
3653

3754
```
38-
cd out/electron...
39-
cd script
40-
chmod +x run.sh
41-
./run.sh
55+
npm run dev
4256
```
57+
58+
### Build
59+
60+
- Linux (Ubuntu):
61+
After successfully installing the dependencies. Run the
62+
63+
```
64+
npm run build:linux
65+
```
66+
67+
#### Build Package:
68+
69+
:round_pushpin: After successfully executing the build command, the target build package will be found in the :file_folder: **dist** folder.
70+
71+
:warning: You may need to install build dependencies for target package. [Learn more](https://www.electronjs.org/docs/latest/development/build-instructions-linux)
72+
73+
:black_nib: You can configure builder as your need. See [electron-builder.yml](./electron-builder.yml) file.
74+
75+
### Contributing
76+
77+
Take a look at the [contributing](./CONTRIBUTING.md) guide lines.

‎build/entitlements.mac.plist‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+
<plist version="1.0">
4+
<dict>
5+
<key>com.apple.security.cs.allow-jit</key>
6+
<true/>
7+
<key>com.apple.security.cs.allow-unsigned-executable-memory</key>
8+
<true/>
9+
<key>com.apple.security.cs.allow-dyld-environment-variables</key>
10+
<true/>
11+
</dict>
12+
</plist>

0 commit comments

Comments
 (0)