Vector Dashboard

A webapp + REST api for controlling your Anki Vector robot friend.

What's this all about?

REST api's are awesome and let a lot more people have access to their vector's from many more languages. This project is meant to provide two things:

1. A REST api that mirrors the vector Python API as closely as possible
2. A webapp frontend for controlling the vector remotely

Docs

This application uses swagger-ui to generate beautiful interactive REST api documentation. Just go to http://localhost:5000/docs to test out API calls on your vector (while running the application, of course).

Running the application:

The fast way, docker:

1. Set up your vector py -m anki_vector.configure
   and follow instructions to set up your vector

2. build and run the server:
   $ docker-compose build && docker-compose up

3. Access via browser http://localhost:5000/docs and you are good to go :)

The less fast way, set up your environment:

1. use pip to install the requirements of the server:
   $ pip install -r requirements.txt
   I highly recommend to use a virtual env to avoid dependency conflicts.

2. install front end dependencies:
   $ cd static
   $ npm install
   $ cd ..

3. build the front end:
   $ npm run build
   You can use 'npm run watch' to avoid building the front end everytime a change is made.

4. Set up your vector py -m anki_vector.configure
   and follow instructions to set up your vector

5. run the server:
   $ uwsgi uwsgi.ini

6. Access via browser http://localhost:5000/docs and you are good to go :)

About

Main Technologies:

• Falcon
• ReactJS
• webpack
• Docker
• Swagger UI

Creating the swagger.json

I currently use this website to build my API docs. If you would like to contribute to this project, I can share you in on it.