You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Getting_started.md
+63-10Lines changed: 63 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -10,28 +10,81 @@ Although a complete environment will be composed of a workstation running nodejs
10
10
11
11
These are the possible choices of development environment.
12
12
13
-
### Web App on Raspberry Pi, backend on Raspberry Pi
13
+
### Web App on workstation, backend on Raspberry Pi
14
14
15
-
The most complete and preferred development environment, it enables development of both components.
15
+

16
16
17
-
1. flash a micro-sd card (at least 8GB RAM, possibly class 10) with the latest release of the Raspberry OS (32bit), using the [Raspberry-provided desktop app](https://www.raspberrypi.com/software/). Do not forget to enable ssh and the WiFi connection configuration.
18
-
2. login via ssh to the Raspberry Pi, [download the script to install requirements](https://github.com/CoderBotOrg/system-install/archive/refs/heads/master.zip)
19
-
3. run the `install_dev.sh` script in the `system-install` directory.
17
+
The most complete and preferred development environment, it enables development of both components: frontend on the workstation (PC or Mac) and backend directly on the Raspberry PI.
20
18
21
-
After the script has been executed, a directory named `coderbot` should be present in the `/home/pi` path.
19
+
### Web App on Raspberry Pi, backend on Raspberry Pi
20
+
21
+

22
+
23
+
This environment is the best option when you only need to develop on the Web App (frontend), while the backend runs on a "real" Raspberry Pi, so fully exposing CoderBot backend APIs.
22
24
23
25
### Web App on workstation, backend on local docker (stub)
24
26
27
+

25
28
26
-
### Web App on workstation, backend on Raspberry Pi
29
+
This environment is a valid alternative for developing the Web App and the CoderBot APIs mocked by the backend "stub" are enough for enabling frontend development.
27
30
31
+
The backend "stub" implements most APIs but mocks most phisycal input and output, such as sensor reading and motor control. Also the camera input is a fixed jpeg image, and cannot be used to test computer vision functions, as well as neural netowrks.
28
32
29
33
## Installation
30
34
31
-
### Workstation
35
+
### Workstation, Web App
36
+
37
+
1. Install [Nodejs](https://nodejs.org/en/) either by installing directly on the workstation or running a docker image (in that case, [install docker](https://docs.docker.com/get-docker/)).
1. flash a micro-sd card (at least 8GB RAM, possibly class 10) with the latest release of the Raspberry OS (32bit), using the [Raspberry-provided desktop app](https://www.raspberrypi.com/software/). Do not forget to enable ssh and the WiFi connection configuration.
50
+
1. login via ssh to the Raspberry Pi, [download the script to install requirements](https://github.com/CoderBotOrg/system-install/archive/refs/heads/master.zip)
51
+
1. run the `install_dev.sh` script in the `system-install` directory.
52
+
53
+
After the script has been executed, a directory named `coderbot` should be present in the `/home/pi` path.
37
54
55
+
Run the backend `cd coderbot && ./start.sh`
56
+
57
+
You should see on the console the output log of the backend starting.
58
+
59
+
The backend is properly started and ready to accept connection from the client when the following line is printed in the log:
0 commit comments