Getting Started🔗

New to GraphQL?🔗

It's recommended to read the official GraphQL docs first to get a better understanding of what GraphQL is and how it works, and use the GraphQL spec as a reference when necessary.

New to Django?🔗

It's recommended to go through the official Django tutorial first before trying to learn Undine, since these docs assume you have some familiarity with Django.

New to Undine?🔗

After going through the installation steps below, we have a tutorial that will walk you through creating a simple GraphQL server using Undine.

Undine is built on top of graphql-core, which is port of the GraphQL.js reference implementation of GraphQL. Knowing how graphql-core works can help you understand how Undine works, but is not required to get started.

Installation🔗

Undine is available on PyPI and can be installed with pip:

1

pip install undine

Next, you'll need to add Undine it to your INSTALLED_APPS setting in your Django project's settings.py file:

1
2
3
4

INSTALLED_APPS = [
    # ...
    "undine",
]

To test that Undine is working, you can run the following command:

1

python manage.py check undine

You should see the message "System check identified no issues (0 silenced)."

Undine requires the "django.contrib.contenttypes" app to be installed, but there is no need to place "undine" in any specific order in the INSTALLED_APPS setting.