# CadQuery Server

CadQuery Server is a self-hosted HTTP service that converts CadQuery Python scripts into Three.js geometry files. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1772/cadquery-server

## Description

CadQuery Server is a self-hosted HTTP service that converts CadQuery Python scripts into Three.js geometry files. It is useful for homelab users who want to generate parametric 3D CAD models programmatically and serve the results to web-based viewers or applications.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

12/100 (Low), based on 2 of 4 factors.
- Maintained: 0 (GitHub repository no longer exists)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/cadquery/cadquery-server
- Unraid: https://ca.unraid.net/apps/cadquery-server-04na3g40bjthl4?q=cadquery-server

## Common questions

### Does the web page update automatically when I edit the Python file?

Yes. It includes a file watcher that reloads the Python code and updates the web page when the file is updated.

### Can cadquery-server generate a static site for projects?

It can build a static website as a showcase for your projects.

### Which Python setup should I use on Linux or Mac?

Install Miniforge into your home folder and activate that environment before installing CadQuery. This keeps CadQuery's files separate from your system Python.

### What should I install if the server is missing the core CAD tools?

Run pip install cadquery in the Python environment used for the server. Without the CadQuery package, the server may fail to start.

### What model issue can make Shell operations fail?

Shell operations fail when the geometry has self intersections, which are not allowed with Shell.

---
Source: Our Local Host (https://ourlocalhost.com/app/1772/cadquery-server), the self-hosted and open-source app directory.
