therealpiotrp / yukon Goto Github PK

An open suite of tools for observing, debugging, and interacting with a UAVCAN v1 bus.

tox build (master)
static analysis
unit test code coverage
documentation
license
community/support

Requirements:

• Python 3.7+ with pip and optional virtualenv
• NodeJS 12.16+ with optional yarn 1.22+

Install dependencies for Frontend:

cd src/yukon/frontend
npm install

Run server with hot code reload:

npm run dev

Build assets for production environment with optimizations:

npm run build

In the second terminal window install backend dependencies:

cd src/yukon/backend
git submodule update --init --recursive
pip3 install -r requirements.txt

If you want to run Yukon demo node:

python src/uavcan_node_demo.py

Run backend:

python src/api/main.py

Install documentation and testing dependencies:

npm install mocha
npm install jsdoc
pip3 install sphinx sphinx-argparse sphinx-js sphinx_rtd_theme

Discussion takes part at the official UAVCAN forum, specifically at Yukon UI & Rest API and GUI Tool - Next Generation forum threads.

• Swaggerhub Api Docs Link

Most up to date swagger json is located at the SWAGGERHUB branch, under /spec. swagger.json