Merge branch 'develop' of https://github.com/CoderBotOrg/coderbot into develop

Author: windwood-xmu

README.md

@@ -1,11 +1,30 @@
-CoderBot
-========
+# CoderBot
 
-A RaspberryPI-based bot controller
+A RaspberryPI-based programmable robot for educational purposes. Check the [project website](https://coderbot.org) for more information.
 
-The module provide a simple web interface to a raspberry py "robot".
+For further information about development and technical documentation, see the [Wiki](https://github.com/CoderBotOrg/coderbot/wiki).
 
-See the [wiki](https://github.com/CoderBotOrg/coderbot/wiki) for the documentation
+This repository contains the backend, along with some configuration applied on the base system image.
 
+### Quickstart
 
+```bash
+git clone https://github.com/CoderBotOrg/coderbot.git
+cd coderbot
+python3 -m venv .
+source bin/activate
+pip3 install -r requirements.txt
+
+# Start the backend in stub mode
+PYTHONPATH=stub python3 init.py
+
+# or, run the real thing if you're on a physical RPi
+python3 init.py
+```
+
+The legacy API and frontend application is available at `localhost:5000`.
+
+The new API is at `localhost:5000/v2`, while the new application is served at `localhost:5000/vue` (assuming the [vue-app](https://github.com/coderbotorg/vue-app) build is placed in the `dist/` folder).
+
+To see the dynamic documentation of the new API, clone the [swagger-ui](https://github.com/coderbotorg/swagger-ui) repository inside the `coderbot/` folder and it'll be live at `localhost:5000/v2/ui/index.html`.
 

api.py

@@ -32,11 +32,19 @@ def turn(data):
 def status():
 	return "ok"
 
+def list(data):
+	return json.dumps(prog_engine.prog_list())
+
 def exec(data):
 	prog = prog_engine.create(data["name"], data["code"])
 	return json.dumps(prog.execute())
 
 def save(data):
 	prog = Program(data["name"], data["code"], data["dom_code"])
 	prog_engine.save(prog)
-	return "ok"
+	return "ok"
+
+def load(data):
+    prog = prog_engine.load(data["id"])
+    return jsonify(prog.as_json())
+

main.py

@@ -56,8 +56,8 @@
 connexionApp = connexion.App(__name__, swagger_ui=True, swagger_path='swagger-ui/')
 # We serve a custom version of the swagger ui (Jinja2 templates) based on the default one
 
-# New API is defined in swagger.yml and api.py
-connexionApp.add_api('swagger.yml')
+# New API is defined in v2.yml and its methods are in api.py
+connexionApp.add_api('v2.yml')
 
 
 # Connexion wraps FlaskApp, so app becomes app

swagger.yml renamed to v2.yml

@@ -12,10 +12,30 @@ basePath: "/v2"
 
 # Paths supported by the server application
 paths:
+  /list:
+    get:
+      operationId: "api.list"
+      summary: "Get the list of all the saved programs"
+      tags:
+        - Program management
+      responses:
+        200:
+          description: "ok"
+  /load:
+    get:
+      operationId: "api.load"
+      summary: "Get the program with the specified ID"
+      tags:
+        - Program management
+      responses:
+        200:
+          description: "ok"
   /save:
     post:
       operationId: "api.save"
       summary: "Save a new program"
+      tags:
+        - Program management
       parameters:
         - in: body
           name: data
@@ -28,6 +48,8 @@ paths:
     post:
       operationId: "api.exec"
       summary: "Execute the given program"
+      tags:
+        - Program management
       parameters:
         - in: body
           name: data