{"id":21061568,"url":"https://github.com/apockill/vector-rest-dashboard","last_synced_at":"2025-05-16T00:34:26.431Z","repository":{"id":95417409,"uuid":"165198838","full_name":"apockill/vector-rest-dashboard","owner":"apockill","description":"A fun side-project to make a REST api for the Anki Vector robot, with a React frontend for controlling the vector. ","archived":false,"fork":false,"pushed_at":"2019-01-28T02:16:21.000Z","size":77,"stargazers_count":10,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-09T14:34:55.569Z","etag":null,"topics":["anki","react","rest-api","vector"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apockill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-11T07:26:44.000Z","updated_at":"2025-03-14T07:07:27.000Z","dependencies_parsed_at":"2023-03-12T18:15:42.586Z","dependency_job_id":null,"html_url":"https://github.com/apockill/vector-rest-dashboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apockill%2Fvector-rest-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apockill%2Fvector-rest-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apockill%2Fvector-rest-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apockill%2Fvector-rest-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apockill","download_url":"https://codeload.github.com/apockill/vector-rest-dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254448058,"owners_count":22072755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anki","react","rest-api","vector"],"created_at":"2024-11-19T17:25:49.335Z","updated_at":"2025-05-16T00:34:26.422Z","avatar_url":"https://github.com/apockill.png","language":"JavaScript","readme":"# Vector Dashboard\nA webapp + REST api for controlling your Anki Vector robot friend.\n\n## What's this all about?\nREST api's are awesome and let a lot more people have access to their vector's\nfrom many more languages. This project is meant to provide two things:\n\n1) A REST api that mirrors the vector Python API as closely as possible\n2) A webapp frontend for controlling the vector remotely\n\n## Docs\nThis application uses swagger-ui to generate beautiful interactive REST api \ndocumentation. Just go to http://localhost:5000/docs to test out API calls on\nyour vector (while running the application, of course).\n\n## Running the application:\n#### The fast way, docker:\n1) Set up your vector\npy -m anki_vector.configure  \nand follow instructions to set up your vector\n\n2) build and run the server:  \n$ docker-compose build \u0026\u0026 docker-compose up\n\n3) Access via browser http://localhost:5000/docs and you are good to go :)\n\n#### The less fast way, set up your environment:\n1) use pip to install the requirements of the server:  \n$ pip install -r requirements.txt  \n  I highly recommend to use a virtual env to avoid dependency conflicts.\n\n2) install front end dependencies:  \n$ cd static  \n$ npm install  \n$ cd ..\n\n3) build the front end:  \n$ npm run build  \n  You can use 'npm run watch' to avoid building the front end everytime a change is made.\n\n4) Set up your vector\npy -m anki_vector.configure  \nand follow instructions to set up your vector\n\n5) run the server:  \n$ uwsgi uwsgi.ini\n\n6) Access via browser http://localhost:5000/docs and you are good to go :)\n\n## About\n#### Main Technologies:\n* Falcon\n* ReactJS\n* webpack\n* Docker\n* Swagger UI\n\n#### Creating the swagger.json\nI currently use [this website](https://app.swaggerhub.com) to build my API docs.\nIf you would like to contribute to this project, I can share you in on it. ","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapockill%2Fvector-rest-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapockill%2Fvector-rest-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapockill%2Fvector-rest-dashboard/lists"}