quickstart¶

Standard Setup (on rover)¶

First, on your rover (CHIP, Raspberry Pi, BeagleBone, etc):

$ sudo apt install git
$ git clone --recursive https://github.com/aninternetof/rovercode.git && cd rovercode
$ sudo bash setup.sh #run this only once -- it will take some time
$ # create your .env, as described in the section below
$ sudo bash start.sh #run this each time you boot the rover (or automatically start if chosen in setup)

Then, on any PC or tablet, head to rovercode.com to connect to your rover. Start playing!

Development Setup (on development PC)¶

When developing rovercode, you may want to run rovercode on your PC instead of a CHIP/Raspberry Pi/Beaglebone. Below are instructions for how to install and run rovercode on your PC. Everything should work fine: rovercode will automatically detect that it is not running on target hardware and will stub out the calls to the motors and sensors.

First, on your development PC:

$ sudo apt install git
$ git clone --recursive https://github.com/aninternetof/rovercode.git && cd rovercode
$ sudo bash setup.sh #run this only once -- it will take some time
$ # create your .env, as described in the section below
$ sudo bash start.sh #run this each time

Then, still on your development PC, head to rovercode.com and connect to your “rover” (your PC running the service).

Alternate Development Setup (on development PC using Docker)¶

Rather use Docker? First, on your development PC:

$ sudo apt install git docker.io
$ git clone --recursive https://github.com/aninternetof/rovercode.git && cd rovercode
$ sudo docker build -t rovercode .
$ # create your .env, as described in the section below
$ sudo docker run --name rovercode -v $PWD:/var/www/rovercode -p 80:80 -d rovercode

Then, still on your development PC, head to rovercode.com and connect to your “rover” (your PC running the service).

Creating Your .env¶

Create a .env file at the root of the project (at the same level as setup.sh and start.sh). In that file, you’ll add your rovercode.com credentials and the name of your rover.

First, create a rovercode.com account [here](https://rovercode.com/accounts/signup/). Then, add your credentials and a name for your rover to the .env so that it looks like this: