Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme.md #7

Merged
merged 4 commits into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 15 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Project Template Name

It Runs the Image of the robotics-academy within electron

## Table of Contents

Expand All @@ -12,38 +11,34 @@ It Runs the Image of the robotics-academy within electron

## About

It uses the docker image to create the Electron desktop app
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.

## Getting Started

Pull the docker image of jderobot/robotics-academy using
TO BUILD AND USE THE APP USE THE FOLLOWING INSTRUCTIONS

```bash
docker pull jderobot/robotics-academy:latest
Install the packages using :

```console
npm install
```

Run the docker container
Build the electron App using :

```bash
docker run --rm -it -p 8000:8000 -p 2303:2303 -p 1905:1905 -p 8765:8765 -p 6080:6080 -p 1108:1108 -p 7163:7163 jderobot/robotics-academy
```console
npm run make
```

Setup electron
After building a **out** folder will be created. Copy the **run.sh** from the **Script** folder and paste it into **out/electron**

```bash
npm install
```
Download and Paste the [Robotics-Academy tar.xz]() into **out/electron/roboticsacademy**

## Usage

Run Electron
To run the App do the following

```bash
npm run start
```

Pack Electron App

```bash
npm run make
cd out/electron...
chmod +x run.sh
./run.sh
```
Loading