Rovercode API

rovercode is an open-source educational robotics platform. Students use our web-based drag-and-drop editor to create code that listens to the rover's sensors and controls its motors.

rovercode is made up of several code repositories. You are currently viewing rovercode-web, the web application backend that provides the API for the frontend. To learn about the other pieces of rovercode, visit our architecture documentation, or start at the root of Rovercode's documentation.

Setup

Install docker and docker-compose, then

$ git clone --recursive https://github.com/rovercode/rovercode-web.git && cd rovercode-web
$ sudo docker-compose -f dev.yml build
$ sudo docker-compose -f dev.yml up
$ google-chrome localhost:8000/docs

Basic Commands

rovercode-web is built with Django. During development, you can do regular Django things like this:

$ docker-compose -f dev.yml run django python manage.py migrate
$ docker-compose -f dev.yml run django python manage.py createsuperuser

More detailed usage instructions can be found here in the docs

Docs

Read the complete docs here

Contributing

Help make rovercode better! Check out the contributing guide.

We'd love to chat with you! Say hello in our chat room.