Skip to main content

Creating a build/development environment online with Codespaces

GitHub Codespaces is a new feature to make is really easy for anyone to build device code (or other projects like out backend server) from scratch. This builds on our existing continuous integration test builds and uses either a bare browser or (optionally) Visual Studio Code. It is a great way for anyone who has problems installing and building locally to get a gauranteed good build environment in the cloud that works and feels just like you are developing on your local machine.

GitHub Codespaces is still in active beta and you need to sign up to a waiting list to get access to it.

Request access to Codespaces

GitHub will then ask you about what languages you code in and what editors you use.

Codespaces language and editor survey

After that you will be added to the waiting list and will be contacted when you can start using it.

On the Codespaces waiting list

Once you have been granted access, go to the project you wish to develop (for example the Meshtastic device code or the backend server code) and click the button in the upper right that says "Fork". It will ask you to confirm, then GitHub will generate your "fork" of the master code.

Browse to your fork of the code and in the upper right of the window click on the "Code" dropdown button, then click "Open with Codespaces".

Github will then create a new virtual machine for you. This will take a few minutes the first time it is created as it installs Platformio and other dependancies.

You can now edit code and click to build and run just like you are on your own machine.