Repository files navigation

CoderBot is a RaspberryPI-based programmable robot for educational purposes. Check theproject website for more information.

For further information about development and technical documentation, see theWiki.

This repository contains the backend, exposing theCoderBot API.

Prerequisites:

sudo apt install python3 python3-venv

Be sure you have Python3.6. You may need to usepython3.6 andpython3.6-venv packages on some repositories with python3 already pointing to3.7 (e.g. debian unstable/sid).

git clone https://github.com/CoderBotOrg/coderbot.gitcd coderbotpython3 -m venv.source bin/activate# Install the basic requirementspip3 install -r requirements_stub.txt# Additional packages if you are running the real thingpip3 install -r requirements.txt# Start the backend in stub modePYTHONPATH=stub:test python3 init.py# or, run the real thing if you're on a physical RPipython3 init.py

Once started, the backend will expose a number of endpoints:

• Legacy API:localhost:5000/<LEGACY_METHOD>;
• Legacy JQuery web application:localhost:5000/old;
• API v2:localhost:5000/v2;
• New Vue web application:localhost:5000/ (assuming avue-app build is placed in thedist/ folder);
• Documentation:localhost:5000/docs assuming adocs build is placed in thecb_docs/ folder);
• Swagger UI dynamic documentation of the API v2:localhost:5000/v2/ui/index.html (once you cloned theswagger-ui repository inside the backend folder).