https://github.com/apockill/vector-rest-dashboard
A fun side-project to make a REST api for the Anki Vector robot, with a React frontend for controlling the vector.
https://github.com/apockill/vector-rest-dashboard
anki react rest-api vector
Last synced: 11 months ago
JSON representation
A fun side-project to make a REST api for the Anki Vector robot, with a React frontend for controlling the vector.
- Host: GitHub
- URL: https://github.com/apockill/vector-rest-dashboard
- Owner: apockill
- Created: 2019-01-11T07:26:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-28T02:16:21.000Z (about 7 years ago)
- Last Synced: 2025-05-09T14:34:55.569Z (11 months ago)
- Topics: anki, react, rest-api, vector
- Language: JavaScript
- Size: 75.2 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://app.swaggerhub.com) to build my API docs.
If you would like to contribute to this project, I can share you in on it.