Local development

Develop within your local environment to get quicker turnaround times and improve the developer experience. To start local development, you have to complete the quickstart guide to set up your instance which you can reuse for local development.

Install dependencies

poetry install

Connect to the created instance

🤖

Skip this step if you followed the quickstart guide, you already have an .env file in your project root with the required environment variables. In case you manually created the project you will need to adapt those values with the following steps:

Connect the template app to the instance by providing the API_HOSTand NOVA_ACCESS_TOKEN environment variables via the .env file. Remember to replace the IP address with the one of your cloud instance.

In case you created an instance which is using Bearer as authorization, you can provide the NOVA_ACCESS_TOKEN. In this example your instance is at MY-HOST.instance.wandelbots.io.

# .env
WANDELAPI_BASE_URL=https://MY-HOST.instance.wandelbots.io
CELL_ID=cell
NOVA_ACCESS_TOKEN="token"

Run the dev server

Once everything is set up, you can run the FastAPI server:

poetry run serve

Open http://localhost:3000/ (opens in a new tab) with your browser and enjoy the result.

You can start developing your application now. Remember: The template app is connected to the instance and provides a connection to the created robot.

If required, you can now debug the application or continue to deploy it to your Wandelbots NOVA instance.

Optional: Debug the application

The template app includes a launch configuration for the debugger integrated in Visual Studio Code thanks to which you'll be able to set breakpoints and debug your application. Just press F5 to start the debugger.

Since the project is a Python module using FastAPI, you can also run the application with any other IDE like PyCharm (opens in a new tab).

Deploy the application

Quickstart Deployment