## File: README.md

[](https://crowdin.com/project/altair-gql)
[](https://chrome.google.com/webstore/detail/altair-graphql-client/flnheeellpciglgpaodhkhmapeljopja)
[](https://addons.mozilla.org/en-US/firefox/addon/altair-graphql-client/)
[](https://www.npmjs.com/package/altair-express-middleware)
[](https://snapcraft.io/altair)
[](https://github.com/altair-graphql/altair/releases)
[](https://github.com/altair-graphql/altair/releases)
[](#backers) [](#sponsors)
[](https://discord.gg/dNNt3MU9hw)





## Documentation

Get started with Altair by reading the [documentation](https://altairgraphql.dev/docs/).

## Sponsors

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](https://opencollective.com/altair/contribute).

### Primary Sponsor

[](https://www.xkoji.dev/)

To be a primary sponsor, [reach out](mailto:sponsor@sirmuel.design) to us.

### Gold Sponsor

Become a [Gold sponsor](https://opencollective.com/altair/contribute/gold-sponsor-27470/checkout) of Altair to appear here.





### Bronze Sponsor


  <a href="https://opencollective.com/opencollective-oss-fund">
    
  </a>


### Other Sponsors


  <a href="https://www.digitalocean.com/?refcode=345176f96acb&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
    
  </a>


## Community 🙏🏾

You can learn more about how to get help [here](.github/community.md).

## Contributing

Would you like to help with translations? https://altair-gql-translate.surge.sh/ [Click here](https://crwd.in/altair-gql).



[](https://opencollective.com/altair#sponsors)

Learn more about contributing to Altair [here](.github/CONTRIBUTING.md) and [here](https://altairgraphql.dev/docs/contributing.html).

## Development

Read more [here](.github/development.md).

## Deployment

### API

#### Docker

The docker image can be built from the [Dockerfile](./Dockerfile) at the root of the repo.

#### Digitalocean

[](https://cloud.digitalocean.com/apps/new?repo=https://github.com/altair-graphql/altair/tree/master&refcode=345176f96acb)

#### Vercel

[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Faltair-graphql%2Faltair&env=JWT_ACCESS_SECRET,EVENTS_JWT_ACCESS_SECRET,JWT_REFRESH_SECRET,GOOGLE_OAUTH_CLIENT_ID,GOOGLE_OAUTH_CLIENT_SECRET,POSTGRES_DB,POSTGRES_USER,POSTGRES_PASSWORD,DATABASE_URL,STRIPE_SECRET_KEY&project-name=altair-graphql-api&redirect-url=https%3A%2F%2Faltairgraphql.dev%2F)

#### Render

[](https://render.com/deploy?repo=https://github.com/altair-graphql/altair)

## License

[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fimolorhe%2Faltair?ref=badge_large)

---

## File: chocolatey/README.md

# altair-graphql chocolatey

This package can be found in the [official Choclatey Repository](https://chocolatey.org/packages/altair-graphql)

# Usage
If you just want to install altair-graphql you can use the official Chocolatey Repository
``` shell script
choco install altair-graphql
```

# Build
If you want to build the chocolatey package yourself you can use the next commands
``` shell script
choco pack
choco install altair-graphql.4.0.11.nupkg
```

---

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

# gatsby-plugin-altair-graphql

Adds an instance of [Altair GraphQL client](https://altairgraphql.dev/) to gatsby, discovered at `/__altair` route.

## Install

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

// or using yarn

yarn add gatsby-plugin-altair-graphql
```

## Usage

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

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

---

## File: packages/altair-plugin/README.md

# altair-graphql-plugin

[](https://www.npmjs.com/package/altair-graphql-plugin)

lugin helper for altair graphql client

---

## File: packages/altair-koa-middleware/README.md

# altair-koa-middleware

[](https://www.npmjs.com/package/altair-koa-middleware)

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

### Installation

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

```
npm install --save altair-koa-middleware
```

Alternatively, if you are using [`yarn`](https://yarnpkg.com/):

```
yarn add altair-koa-middleware
```

### Usage

```js
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

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

[MIT](../../LICENSE)

---

## File: packages/altair-fastify-plugin/README.md

# altair-fastify-plugin

[](https://www.npmjs.com/package/altair-fastify-plugin)

This is a [**Fastify Plugin**](https://www.fastify.io/docs/master/Plugins/) for hosting an instance of **Altair GraphQL Client**, with support for **TypeScript**, and tested for **Fastify v3**.

## Install

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

## Usage

```js
// 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

# altair-express-middleware

[](https://www.npmjs.com/package/altair-express-middleware)

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

### Installation

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

```
npm install --save altair-express-middleware
```

Alternatively, if you are using [`yarn`](https://yarnpkg.com/):

```
yarn add altair-express-middleware
```

### Usage

```js
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

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

[MIT](../../LICENSE)

---

## File: packages/altair-docs/docs/cloud/accounts.md

---
title: Accounts
parent: Cloud
order: 2
---

# 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](https://accounts.google.com/signup). _(If you think there should be other ways to sign up, please let us know by [contacting support](/docs/cloud/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.