Skip to content

Latest commit

 

History

History
175 lines (110 loc) · 11.1 KB

README.md

File metadata and controls

175 lines (110 loc) · 11.1 KB

Build All Contributors Build status FOSSA Status Crowdin Gitter

Chrome Web Store Chrome Web Store Chrome Web Store Mozilla Add-on npm Altair GraphQL Client GitHub release Github All Releases

Backers on Open Collective Sponsors on Open Collective

Maintenance Greenkeeper badge lerna Reviewed by Hound

Deploying?

Altair GraphQL Client

Deploying to ShipperHQ Playground Site

The playground site is located on our test AWS accounts S3 bucket.

To deploy, you will need to run yarn build from the root directory of this repository. That will generate the dist folder.

Copy the contents of the dist folder to the folder in the S3 bucket called graphiql-dev.shipperhq.com

That completes the steps required to deploy any updates

Donate to Altair

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

set url

A graphQL client for making graphQL queries to a graphQL server - similar to Postman but for GraphQL.

Web app: https://altair-gql.sirmuel.design/

There's a chrome extension and a firefox add-on.

There are apps for mac, windows and linux users as well.

You can also install using cask:

$ brew cask install 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

Usage with express

You can use altair with an express server using altair-express-middleware. Read more about how to use this here.

Usage with koa

You can use altair with a koa server using altair-koa-middleware. Read more about how to use this here.

Features

  • Headers
  • Variables
  • Response Stats
  • Documentation (via introspection)
  • Documentation search
  • Syntax highlighting
  • Error highlighting
  • Add queries and fragments from documentation add fragment
  • Upload files via GraphQL
  • Autocompletion of fields, arguments, types, etc
  • Autofill all fields at cursor
  • Schema auto refresh
  • Prettify Query
  • Compress Query
  • History of recent queries
  • Multiple Windows
  • GraphQL Subscriptions (with desktop notifications)
  • Import/Export Queries
  • Multiple Languages
  • Light and Dark themes

See more here: https://altair.sirmuel.design/docs/features

Missing feature?

Is there a feature that is missing? You can let us know by creating a new issue or you can add the feature by creating a Pull Request.

Development server

Run yarn start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run yarn build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Generate chrome extension files

Run yarn build-ext to build the chrome extension files. The extension files will be stored in the chrome-extension/ directory.

Generate electron app

Run yarn build-electron to build the electron apps. The apps will be stored in the electron-builds/ directory.

Updating docs

Run bundle exec jekyll serve.

Running tests

Run yarn test to execute the unit tests via Karma and the end-to-end tests via Protractor.

Further help

To get more help on working with the project, check out the Angular CLI README.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

FOSSA Status

Contributors

Thanks goes to these wonderful people (emoji key):

Danilo Caruso
Danilo Caruso

🌍
Igor Szymanski
Igor Szymanski

🌍
Kevin Porten
Kevin Porten

🌍
JongChan Choi
JongChan Choi

🌍
Alexey Rodionov
Alexey Rodionov

📖
kurisutofu
kurisutofu

🌍
Claércio Santos
Claércio Santos

🌍
jenda
jenda

🌍
pcharbon70
pcharbon70

🌍
Juan Cruz
Juan Cruz

🌍
Victor Mihaita
Victor Mihaita

🌍

This project follows the all-contributors specification. Contributions of any kind welcome!