Skip to content

✨⚡️ A beautiful feature-rich GraphQL Client for all platforms.

License

Notifications You must be signed in to change notification settings

jasonlin15/altair

This branch is 622 commits behind altair-graphql/altair:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

98e276c · Jan 28, 2024
Jan 10, 2024
Jan 26, 2024
Aug 23, 2022
Dec 28, 2023
Jan 27, 2024
Jan 22, 2023
Jan 13, 2023
Jan 27, 2024
Jan 28, 2024
Dec 16, 2023
Jun 23, 2021
Nov 21, 2021
Dec 28, 2023
Feb 2, 2023
Jan 7, 2023
Nov 15, 2017
Jan 26, 2024
Aug 18, 2020
Jan 7, 2023
Jan 7, 2023
Jul 4, 2019
Aug 23, 2022
Feb 15, 2023
Dec 28, 2023
Feb 15, 2023
Dec 12, 2023
Jan 17, 2024
Jan 27, 2024
Jan 14, 2020
Jan 27, 2024
Feb 2, 2023
Dec 30, 2022
Jan 14, 2023
Feb 2, 2023
Feb 2, 2023
Jan 27, 2024
May 28, 2022
Jan 27, 2024
Mar 20, 2023
Jan 12, 2024
Apr 23, 2023
Feb 9, 2023
Jan 26, 2024

Repository files navigation

Crowdin Chrome Web Store Mozilla Add-on npm Altair GraphQL Client GitHub release Github All Releases Backers on Open Collective Sponsors on Open Collective Maintenance

Deploying?

set url

Altair is a beautiful feature-rich GraphQL Client IDE for all platforms. Available for MacOS, Windows, Linux, Chrome, Firefox. It enables you interact with any GraphQL server you are authorized to access from any platform you are on.

-- the GraphQL IDE that does not require running a web server

Features

See details here: https://altairgraphql.dev/docs/features

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 major sponsor (primary, gold, silver or bronze) on open collective.

Primary Sponsor

XKojiMedia

To be a primary sponsor, reach out to us.

Gold Sponsor

Become a Gold sponsor of Altair to appear here.

Bronze Sponsor

Other Sponsors

Usage

For mac users, you can also install using cask:

$ brew install --cask altair-graphql-client

For linux users, you can also install using snap:

$ snap install altair

For arch linux users, an AUR package aur/altair exists:

$ yay -S altair

For windows users, you can install using chocolatey:

$ choco install altair-graphql

...or winget:

$ winget install -e --id altair-graphql.altair

You can find other available integrations here: https://altairgraphql.dev/docs/integrations

Configuration Options

When using a custom instance of Altair, there are couple of options you can use to customize Altair based on your needs:

  • endpointURL string - URL to set as the server endpoint
  • subscriptionsEndpoint string - URL to set as the subscription endpoint
  • initialSubscriptionsProvider "websocket" | "graphql-ws" | "app-sync" | "action-cable" - Initial subscriptions provider
  • initialQuery string - Initial query to be added
  • initialVariables string - Initial variables to be added (in JSON format) e.g. '{ "var1": "first variable" }'
  • initialPreRequestScript string - Initial pre-request script to be added e.g. 'altair.helpers.getEnvironment("api_key")'
  • initialHeaders IDictionary - Initial headers object to be added
{
  'X-GraphQL-Token': 'asd7-237s-2bdk-nsdk4'
}
  • initialEnvironments IInitialEnvironments - Initial Environments to be added
{
  base: {
    title: 'Environment',
    variables: {}
  },
  subEnvironments: [
    {
      title: 'sub-1',
      variables: {}
    }
  ]
}
  • instanceStorageNamespace string - Namespace for storing the data for the altair instance. Use this when you have multiple altair instances running on the same domain. e.g. 'altair_dev_'

Example usage:

AltairGraphQL.init({
  endpointURL: 'https://www.example.com/graphql',
  initialVariables: '{ "username": "imolorhe" }',
});

Supported Browsers

Altair has been tested in the latest versions of Google Chrome and Mozilla Firefox. It might not work as expected in other browsers like Safari and Edge.

Community 🙏🏾

You can learn more about how to get help here.

Contributing

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

Donate to Altair

Learn more about contributing to Altair here and here.

Development

Read more here.

Deployment

API

Docker

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

Digitalocean

Deploy to DO

Vercel

Deploy with Vercel

Render

Deploy to Render

License

FOSSA Status

About

✨⚡️ A beautiful feature-rich GraphQL Client for all platforms.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 66.2%
  • Vue 11.7%
  • HTML 7.7%
  • JavaScript 5.1%
  • CSS 3.9%
  • SCSS 3.6%
  • Other 1.8%