Open Roberta Lab
Build status:
- master
- develop
We use BrowserStack for Cross-Browser Testing
Introduction
The steps below explain how to get started with the sources. If you just want to run the server locally, please have a look into the wiki - installation. If you want to contribute, please get in touch with us, see wiki - Community before you start.
After a fresh git clone you get the robertalab project folder. It includes everything you need to setup and extend your own browser programming environment. License information is available in the docs folder.
Things you need on your computer:
- Java 1.8
- Maven >= 3.2
- Git
- Web browser
If you would like the server to compile code for the different systems, you need to install additional software:
on linux:
- Arduino based robots
- sudo apt-get install libusb-0.1-4
- sudo apt-get install gcc-avr binutils-avr gdb-avr avr-libc avrdude
- NXT
- sudo apt-get install nbc
- Calliope
- sudo apt-get install gcc-arm-none-eabi srecord libssl-dev
- micro:bit
- pip install uflash
on windows:
- Calliope
- install gcc-arm-none-eabi (see: http://gnuarmeclipse.github.io/toolchain/install/)
- install srecord (see: http://srecord.sourceforge.net/)
- micro:bit
- install python
- pip install uflash
Please also check our wiki for detailed installation instructions, development procedure, coding conventions and further reading. We also use the github issue tracking system. Please file issues in the main project robertalab.
Fast installation with maven
Step 1: Clone the repository and compile
git clone https://github.com/OpenRoberta/robertalab.git # get the repository
cd robertalab # cd into repository
cd OpenRobertaParent # cd to parent project
mvn clean install # generate the server
cd .. # return to the repository
Get a coffee! Might take some time.
A successful build looks like:
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] RobertaParent ...................................... SUCCESS [ 2.479 s]
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 02:16 min
[INFO] Finished at: 2018-01-07T13:05:00+02:00
[INFO] Final Memory: 60M/540M
[INFO] ------------------------------------------------------------------------
Step 2: Make sure you have a database
If you have a fresh clone of the server, make sure that the OpenRobertaServer folder has a subfolder db-x.y.z with the database inside, where x.y.z is the current version from the server. The actual server version is found in the pom.xml of the OpenRobertaParent project. If you don't have a database, you can create an empty database with
./ora.sh --createEmptydb
You can also create a specific db version:
./ora.sh --createEmptydb x.y.z
If the server version is x.y.z-SNAPSHOT, remove the -SNAPSHOT. If you update the server later with git pull, your database will not be changed.
Step 3: Starting your own server instance using a unix-like shell (on either lin* or win*).
./ora.sh --start-from-git # start the server using the default properties
You can also run ./ora.sh --help for more options.
Step 4: Accessing your programming environment
Start your browser at: http://localhost:1999
That's it!
Development notes
You can follow the test status on https://travis-ci.org/OpenRoberta/.
Development happens in the develop branch. Please sent PRs against that branch.
git clone https://github.com/OpenRoberta/robertalab.git
cd robertalab
git checkout -b develop origin/develop
The project OpenRobertaServer contains the server logic, that accesses
- a database with Hibernate-based DAO objects
- plugins for various robots which are supported in OpenRoberta
- services for browser-based clients
- services for robots connected to the lab either by Wifi or USB
The server is made of
- an embedded jetty server exposing REST services
- the services are based on jersey
- JSON (sometimes XML or plain text) is used for data exchange between front, robots and server
Furthermore, the project OpenRobertaServer contains in directory staticResources for the browser client
- HTML and CSS
- Javascript libraries based on jquery and bootstrap for the frontend
- assertions (DBC), ajax-based server calls (COMM), logging (LOG) and
- javascript resources for blockly (see: http://code.google.com/p/blockly/)
- controller and models written in Javascript, which implement the GUI
To run specific tests, use mvn test with the -Dtest= option to specify the
test name and -DfailIfNoTests=false to avoid a failure if a test of such name
is not present in every sub-project of the repository. Example:
mvn -Dtest=de.fhg.iais.roberta.syntax.codegen.PythonVisitorTest -DfailIfNoTests=false test
If the tests report broken dependencies, make sure to run mvn clean install
first.
Blockly
We are using Blockly, it is located in a separate repository. The build of the blockly is only done in the OpenRoberta/Blockly project and then copied to the OpenRobertaServer/staticResources. You can not build Blockly in OpenRobertaServer project directly.