Official server-side implementation of the LibrePCB API as accessed by the LibrePCB application. Note that some older API paths are implemented in a different way and might be migrated to this repository later.

Only Docker Compose is needed to run this server on a Linux machine.

To make all features working, a configuration file config/api.json is required with the following content:

{ /* Config for endpoint '/parts' */ "parts_operational": false, "parts_query_url": "", "parts_query_token": "" }

For local development, the server can be run with this command:

docker-compose up --build

Afterwards, the API runs on http://localhost:8000/:

curl -X POST -H "Content-Type: application/json" -d @demo-request.json \ 'http://localhost:8000/api/v1/parts/query' | jq '.'

The content in this repository is published under the GNU GPLv3 license.