Giter VIP home page Giter VIP logo

altair-graphql / altair Goto Github PK

View Code? Open in Web Editor NEW
5.0K 41.0 305.0 48.74 MB

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

Home Page: https://altairgraphql.dev

License: MIT License

TypeScript 70.80% JavaScript 2.97% HTML 8.19% Shell 0.40% SCSS 3.71% Less 0.80% CSS 4.03% Vue 8.99% PowerShell 0.03% Dockerfile 0.08%
graphql graphql-client angular altair chrome-extension electron opensource graphql-editor graphql-ide ngrx

altair's Introduction

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

altair's People

Contributors

alexandruvaleanu avatar allcontributors[bot] avatar andrewhyi avatar dependabot[bot] avatar eokoneyo avatar eole1712 avatar fabianfrangella avatar fluorescenthallucinogen avatar greenkeeper[bot] avatar horvathmarton avatar imolorhe avatar jaydenseric avatar joseph-so avatar lenartbezek avatar lon-io avatar mathewthecoder avatar mbao01 avatar mokeyish avatar monkeywithacupcake avatar nishant-nagururu avatar pabloszx avatar qonn avatar rfigueroa avatar salbertson avatar seanonthenet avatar sganz avatar snyk-bot avatar tiago404 avatar tizmagik avatar vrobik avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

altair's Issues

Add github page

Add a github page with more information about altair, and links to all the other dependent products.

Fix buggy implementation of add query functionality

The add query functionality does not work and hangs the application in certain conditions.
This should be addressed.

Expected Behavior

Adding a query should always work, else the button shouldn't be there.

Current Behavior

For some graphQL servers, when you click the "Add Query" button, the application hangs.

Possible Solution

The likely culprit is because of an infinite recursive loop. If the recursion is unending, a maximum depth limit can be set. It is not likely that a user would want to add a query with more than 50 (random number) depth fields, for instance.

Steps to Reproduce (for bugs)

  1. Enter a valid graphQL server URL with introspection enabled.
  2. Open the docs
  3. Click the "Add Query" button that appears when you hover over a query.

Context

Your Environment

  • Version used:
  • Environment name and version (e.g. Chrome 39, node.js 5.4):
  • Operating System and version (desktop or mobile):
  • Link to your project:

Duplicate Search Results

Duplicate results for the same search query are returned. Apperently, this is due to the same keyword being found across 2 or more of a mutation name; query name; and field name.

altair 2017-08-07 10-57-04

variables

hi ,

i have a question, how to add variables in to request ?

query: "query ($filters: [FilterInput]!, $cursor: String, $order: OrderInput!)..."
variables : {}

thanks,
Janek

Docs not reloading

Hi,

Great tool. Any way to force reloading of docs in the Chrome extension?

Show error message

I just tried to play around with the github graphql api and forgot to enter my token. It only said "Server Error", I had to check the console logs to see what was wrong.

1.4.5 ignores set headers

im setting header and its being ignored

Expected Behavior

added header to request headers

Current Behavior

header is ignored

Possible Solution

was working before so it happened in current update

Steps to Reproduce (for bugs)

  1. add header
  2. reload page / docs
  3. check request headers in network tab

Context

cannot check results in production env - requires jwt auth header

Your Environment

Version 62.0.3202.89 (Official Build) (64-bit)

Add the docs section

Implement the docs section so the users can see the possible queries for the currently set graphQL server.

Autocomplete makes aliasing quite difficult

If there is a similarly spelled field, is is impossible to type out an alias. For example, if I have root query fields node and field2 it isn't possible to alias one as foo: node(id: "xxx") because typing the "f" in "foo" autocompletes to "field2".

The only way to get the correct field is either with some typing gymnastics (starting to type "xxxfoo" then removing the "xxx") or copy-and-paste from another editor.

At the very least it should be possible to switch off autocomplete, while keeping the autosuggest functionality.

Add query to query editor from docs

When I view a query in the docs, I should be able to click a button to automatically replace (or append to) my current query in the editor with a scaffold of the currently selected query field as a full query or fragment, depending on if it is on a root type or a sub type.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.