altair Documentation

File: README.md Copy Chapter

Documentation Copy Chapter

Get started with Altair by reading the documentation.

Sponsors Copy Chapter

Thanks to all our sponsors for sponsoring this project! Do you use Altair GraphQL client at your company? Consider supporting this project as a sponsor (primary, gold, silver or bronze) on open collective.

Primary Sponsor Copy Section

To be a primary sponsor, reach out to us.

Gold Sponsor Copy Section

Become a Gold sponsor of Altair to appear here.

Bronze Sponsor Copy Section

Other Sponsors Copy Section

Community 🙏🏾 Copy Chapter

You can learn more about how to get help here.

Contributing Copy Chapter

Would you like to help with translations? https://altair-gql-translate.surge.sh/ Click here.

Learn more about contributing to Altair here and here.

Development Copy Chapter

Read more here.

Deployment Copy Chapter

API Copy Section

Docker

The docker image can be built from the Dockerfile at the root of the repo.

Digitalocean

Vercel

Render

License Copy Chapter

File: chocolatey/README.md Copy Chapter

altair-graphql chocolatey

This package can be found in the official Choclatey Repository

Usage

If you just want to install altair-graphql you can use the official Chocolatey Repository

choco install altair-graphql

Build

If you want to build the chocolatey package yourself you can use the next commands

choco pack
choco install altair-graphql.4.0.11.nupkg

File: packages/gatsby-plugin-altair-graphql/README.md Copy Chapter

gatsby-plugin-altair-graphql

Adds an instance of Altair GraphQL client to gatsby, discovered at /__altair route.

Install Copy Chapter

npm install --save gatsby-plugin-altair-graphql

// or using yarn

yarn add gatsby-plugin-altair-graphql

Usage Copy Chapter

Just add the plugin to the plugins array in your gatsby-config.js

plugins: [`gatsby-plugin-altair-graphql`]

File: packages/altair-plugin/README.md Copy Chapter

altair-graphql-plugin

lugin helper for altair graphql client

File: packages/altair-koa-middleware/README.md Copy Chapter

altair-koa-middleware

This is a koa middleware for mounting an instance of altair GraphQL client.

Installation Copy Section

This is a node module and can be installed using npm:

npm install --save altair-koa-middleware

Alternatively, if you are using yarn:

yarn add altair-koa-middleware

Usage Copy Section

import Koa from 'koa';
import KoaRouter from 'koa-router';
import { createRouteExplorer } from 'altair-koa-middleware';
const app = new Koa();
const router = new KoaRouter();

createRouteExplorer({
  url: '/altair',
  router,
  opts: {
    endpointURL: '/graphql',
    subscriptionsEndpoint: `ws://localhost:4000/subscriptions`,
    initialQuery: `{ getData { id name surname } }`,
  },
});

app.use(router.routes()).use(router.allowedMethods());

app.listen(3500);

// ... the rest of your code ...

An instance of Altair GraphQL Client would be available at /altair of your server.

Contributing Copy Section

Everyone is welcome to contribute. See anything that needs improving, create an issue. And if you're up for it, create a PR! :D

License Copy Section

MIT

File: packages/altair-fastify-plugin/README.md Copy Chapter

altair-fastify-plugin

This is a Fastify Plugin for hosting an instance of Altair GraphQL Client, with support for TypeScript, and tested for Fastify v3.

Install Copy Chapter

npm install altair-fastify-plugin
# or
yarn add altair-fastify-plugin

Usage Copy Chapter

// const Fastify = require("fastify");
import Fastify from 'fastify';
// const AltairFastify = require("altair-fastify-plugin");
import AltairFastify from 'altair-fastify-plugin';

const app = Fastify();

// ...

app.register(AltairFastify, {
  /**
   * All these are the defaults.
   */
  path: '/altair',
  baseURL: '/altair/',
  endpointURL: '/graphql',
});

// ...

// Altair available at localhost:3000/altair
app.listen(3000);

File: packages/altair-express-middleware/README.md Copy Chapter

altair-express-middleware

This is an express middleware for mounting an instance of altair GraphQL client.

Installation Copy Section

This is a node module and can be installed using npm:

npm install --save altair-express-middleware

Alternatively, if you are using yarn:

yarn add altair-express-middleware

Usage Copy Section

import express from 'express';
import { graphqlExpress } from 'graphql-server-express';
import { altairExpress } from 'altair-express-middleware';

import { schema } from './schema';

const server = express();

// Mount your graphQL server endpoint
server.use(
  '/graphql',
  bodyParser.json(),
  graphqlExpress({
    schema,
  })
);

// Mount your altair GraphQL client
server.use(
  '/altair',
  altairExpress({
    endpointURL: '/graphql',
    subscriptionsEndpoint: `ws://localhost:4000/subscriptions`,
    initialQuery: `{ getData { id name surname } }`,
  })
);

// ... the rest of your code ...

An instance of Altair GraphQL Client would be available at /altair of your server.

Contributing Copy Section

Everyone is welcome to contribute. See anything that needs improving, create an issue. And if you're up for it, create a PR! :D

License Copy Section

MIT

File: packages/altair-docs/docs/cloud/accounts.md Copy Chapter

title: Accounts parent: Cloud order: 2 Copy Chapter

Managing your account

To get started with Altair GraphQL Cloud, you need to sign up for an account. To access the login dialog, hover the user icon at the bottom left corner of Altair and click on the Login link.

Currently the only way to sign up for an account is by using Google Sign-In. If you don't have a Google account, you can create one here. (If you think there should be other ways to sign up, please let us know by contacting support.)

Once you've signed in, you now have access to manage your account and teams, and to log out.

Your profile shows you basic stats about your account, such as the number of queries you have created and the number of teams you manage.