Skip to content

Contributing

Constributing is simple:

  1. Fork the repository
  2. Make your changes
  3. Open a pull request
  4. Get the pull request reviewed
  5. Merge into main

Development

The development environment follows the same steps as the installation guide, so we refer to it there. The only main point is to use the uv installation instead of the docker installation.

Here is a sample vscode debug configuration:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: GraphQLer",
            "type": "debugpy",
            "request": "launch",
            "program": "${workspaceFolder}/graphqler",
            "args": [
                "--url", "https://<endpoint>/graphql",
                "--path", "output-test/<my-test>",
                "--config", "output-test/<my-test>.toml",
                "--mode", "run"
            ],
            "console": "integratedTerminal",
            "justMyCode": true
        }
    ]
}

Running tests

To run end-to-end tests, you will have to first set up the sample APIs by running the following:

Food delivery API:

cd sample-graphql-apis/food-delivery-api
npm install
node dbinitializer.js
node server.js