Skip to content

Commit 7160939

Browse files
committed
Updated README and modified license to comply with TUD OSS
1 parent be44ec8 commit 7160939

File tree

2 files changed

+31
-20
lines changed

2 files changed

+31
-20
lines changed

LICENSE

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,3 +672,8 @@ may consider it more useful to permit linking proprietary applications with
672672
the library. If this is what you want to do, use the GNU Lesser General
673673
Public License instead of this License. But first, please read
674674
<https://www.gnu.org/licenses/why-not-lgpl.html>.
675+
676+
Technische Universiteit Delft hereby disclaims all copyright interest
677+
in the software of "MIRTE robot" (an educational robot) written by the
678+
Author(s).
679+
prof. dr. ir. Fred van Keulen, Dean of Mechanical Engineering

README.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,53 @@
11
# mirte-web-interface
22

3-
This repository contains both the backend (NodeJS) and frontend (Vue) of the robot.
3+
This repository contains both the backend (NodeJS) and frontend (Vue) of
4+
the [MIRTE robot](https://mirte.org). Please read the [MIRTE documentation](https://docs.mirte.org/)
5+
on how this can be used.
46

5-
## Preparations
7+
## Build preparations
68

79
In order to build and run both the frontend and backend one needs an installation of NodeJS. We
810
prefer using nodeenv.
911

10-
```
12+
```sh
1113
sudo apt install -y python3-pip python3-setuptools python3-wheel
1214
sudo -H pip install nodeenv
1315
nodeenv --node=16.2.0 node_env
1416
source node_env/bin/activate
1517
```
1618

17-
## Build and run the frontend
19+
## Build
1820

19-
```
20-
cd vue-frontend
21-
npm install .
22-
npm run build
23-
```
21+
- backend:
2422

25-
This will build a dist folder which will be served by the backend.
23+
```sh
24+
cd nodejs-backend
25+
npm install .
26+
npm run backend
27+
```
2628

29+
- frontend:
2730

28-
## Build and run the backend
31+
```sh
32+
cd vue-frontend
33+
npm install .
34+
npm run build
35+
```
36+
This will build a dist folder which will be served by the backend.
2937

30-
```
31-
cd nodejs-backend
32-
npm install .
33-
npm run backend
34-
```
3538

36-
## Develop for the frontend
39+
## Build locally, and deploy on robot
3740

38-
The orange pi might not have enough power to build the backend. In order to develop on your own machine
39-
you could also serve the frontend on your local machine (without the backend).
41+
The SBC of the robot might not have sufficient RAM to actually build the
42+
frontend. You can also build the frontend locally, and then deploy it
43+
to the robot:
4044

4145
```
4246
cd vue-frontend
4347
npm install .
44-
npm run serve
48+
rm -rf dist && npm run build && scp -R dist mirte@<mirte-ip>:/usr/local/src/mirte/mirte-web-interface/vue-frontend/
4549
```
4650

51+
## License
4752

53+
This work is licensed under a Apache-2.0 OSS license.

0 commit comments

Comments
 (0)