First Steps | wundergraph
Version: Next

First Steps

This document will guide you through the process of getting started with WunderGraph.

The main Components of WunderGraph

WunderGraph is made up of three main components:

  1. The Console:

    The Console is the component to configure your Applications

  2. The WunderNode

    The WunderNode is the working horse of the stack. Whatever you configure through the Console, the WunderNode is going to execute it. It does all the heavy lifting like implementing the Auth flows, persisting & executing Queries etc.

    You can run the WunderNode in every environment that supports Docker, e.g. your laptop or any kubernetes provider.

  3. The WunderGen

    WunderGen is our code generator. It takes your Application Configuration and generates a client for it. This client is capable of authenticating against your WunderNode, has type definitions for your whole schema and knows all the persisted Operations.

How to work with WunderGraph

A typical development workflow looks like this:

  1. Register all your DataSources (APIs) in the Console

  2. If you want to use multiple DataSources for the same Application you can add a composed DataSource which combines multiple APIs to a single unified API.

  3. Create an Application

    3.1 Define your operations

    3.2 Configure Auth & Security

    3.3 Configure the deployment, e.g. run the application on your development Gateway

    Your application should now be running on the configured WunderNode

  4. Generate a typesafe client

  5. Use the client in your application to login a user and/or fetch data.

At this point you're through the initial cycle.

From here you will possibly do the following flows:

  • Add more DataSources, update the Application, add more Operations, regenerate the client, use new Operations, redeploy the App
  • Add more Operations, regenerate the client, use new Operations, redeploy the App

Next Steps

  1. Go to the Console and create an account
  2. Configure your WunderNode from the console (setup Address)
  3. Run your WunderNode
  4. Go through the development cycle outlined above
  5. Feel productive!
  6. Share with your friends how much time you saved