Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.12 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.12 KB
Raw

Skybrush Live

This is the official desktop and web frontend for the Skybrush server.

Steps to install

  1. Install Node.js and npm (the Node.js Package Manager). Note that Ubuntu Linux may contain an old version of Node.js at the time of writing and we need a recent one, so you need to run the following from the command line:

    curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

    If you are running Windows, you should probably download an installer from here that contains both.

  2. Install all the dependencies of skybrush-live by running npm install from a fresh checkout of the repository. (Note for Windows: For some reason the PATH environment variable of cmd is not always the same as the one in PowerShell, so you may have to use the latter one or alternatively git-shell for the command above to run properly.)

  3. Copy .env.example to .env and include your Bing Maps / Mapbox / Mapzen API key in it if you want to support these map providers. (None of them are required).

  4. Start a development web server with npm start inside skybrush-live, and navigate to http://localhost:8080 from your browser. Alternatively, run npm run start:electron to run Skybrush Live within its own desktop app window.

Support

For any support questions please contact us on our Discord server.

License

Copyright 2018-2024 CollMot Robotics Ltd.

Skybrush Live is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Skybrush Live is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.