Docker-based Development¶

Docker is a great way to quickly fire up a local development environment without having to install Python locally.

Prerequisites¶

Install Docker and double-check that you can run the following two commands on a Terminal/Command Prompt:
```
docker
docker compose
```
Follow Git Repository Setup.
If you want to use Office.js add-ins, you need to first create development certificates. If you will be using VBA, Office Scripts, or Google Apps Script, you can skip this step.

Running the development server¶

In the root of the repo, run:

docker compose up

If you run this for the first time, it will build the development container first, then start the server. In the end, you should see something like this in your Terminal:

✔ Network xlwings-server_default  Created                                                                                                              0.0s
✔ Container xlwings-server-app-1  Created                                                                                                              0.0s
Attaching to app-1
app-1  | INFO:     Will watch for changes in these directories: ['/project/app']
app-1  | INFO:     Uvicorn running on https://0.0.0.0:8000 (Press CTRL+C to quit)
app-1  | INFO:     Started reloader process [1] using WatchFiles
app-1  | INFO:     Started server process [8]
app-1  | INFO:     Waiting for application startup.
app-1  | INFO:     Application startup complete.

Open https://127.0.0.1:8000 in a browser (use http:// instead of https:// if you didn’t create the development certificates). You should see {"status": "ok"}.
If you are using the Office Scripts or Google Apps Script integrations, set up Tunneling. If you are using Office.js add-ins or the VBA integration, you can skip this step.