https://github.com/david-swift/graphql-viewer-macos
A macOS app for viewing GraphQL schemas and generating GraphQL Swift packages
https://github.com/david-swift/graphql-viewer-macos
app graphql macos swift swiftui
Last synced: 8 months ago
JSON representation
A macOS app for viewing GraphQL schemas and generating GraphQL Swift packages
- Host: GitHub
- URL: https://github.com/david-swift/graphql-viewer-macos
- Owner: david-swift
- License: mit
- Created: 2023-06-25T10:50:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T19:32:08.000Z (almost 2 years ago)
- Last Synced: 2024-01-05T20:36:26.492Z (almost 2 years ago)
- Topics: app, graphql, macos, swift, swiftui
- Language: Swift
- Homepage: https://david-swift.gitbook.io/graphql-viewer/
- Size: 11.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
GraphQL Viewer
User Manual
·
GitHub
·
Download GraphQL Viewer
A native macOS app for viewing docs for a GraphQL schema (`.graphql` file) and automatically creating a Swift package using [GraphQLKit][1] for that schema.
![GitHub Banner][image-1]
## Table of Contents
- [Installation][2]
- [Usage][3]
- [Thanks][4]
## Installation
1. Download GraphQL Viewer [here][5].
2. Move `GraphQL Viewer.app` from the `Downloads` into the `Applications` folder.
3. Press and hold the `Ctrl` key while you click on `GraphQL Viewer.app` in the `Applications` folder. Do not launch it from the Launchpad or by double-clicking.
4. Click on `Open`.
5. In the panel that appears now, click on `Open`.
## Usage
* [Getting Started][6]
### Basics
* [View Documentation][7]
* [Search Documentation][8]
* [Export a Schema to Swift][9]
### Customization
* [Appearance][10]
### More Information
* [Keyboard Shortcuts][11]
* [Keyboard Shortcut Symbols][12]
## Thanks
### Dependencies
- [GraphQLLanguage][13] licensed under the [MIT license][14]
- [MarkdownUI][15] licensed under the [MIT license][16]
- [PigeonApp][17] licensed under the [MIT license][18]
- [SwiftLintPlugin][19] licensed under the [MIT license][20]
### Other Thanks
- The [contributors][21]
- [SwiftLint][22] for checking whether code style conventions are violated
- Chris Eidhof: Article [A Fast Fuzzy Search Implementation][23]
- The programming language [Swift][24]
[1]: https://github.com/david-swift/GraphQLKit-macOS
[2]: #Installation
[3]: #Usage
[4]: #Thanks
[5]: https://github.com/david-swift/GraphQL-Viewer-macOS/releases/latest/download/GraphQL.Viewer.app.zip
[6]: user-manual/GettingStarted.md
[7]: user-manual/Basics/ViewDocumentation.md
[8]: user-manual/Basics/SearchDocumentation.md
[9]: user-manual/Basics/ExportSchemaToSwift.md
[10]: user-manual/Customization/Appearance.md
[11]: user-manual/MoreInformation/Shortcuts.md
[12]: user-manual/MoreInformation/ShortcutSymbols.md
[13]: https://github.com/niw/GraphQLLanguage
[14]: https://github.com/niw/GraphQLLanguage/blob/master/LICENSE
[15]: https://github.com/gonzalezreal/swift-markdown-ui
[16]: https://github.com/gonzalezreal/swift-markdown-ui/blob/main/LICENSE
[17]: https://github.com/david-swift/PigeonApp-macOS
[18]: https://github.com/david-swift/PigeonApp-macOS/blob/main/LICENSE.md
[19]: https://github.com/lukepistrol/SwiftLintPlugin
[20]: https://github.com/lukepistrol/SwiftLintPlugin/blob/main/LICENSE
[21]: Contributors.md
[22]: https://github.com/realm/SwiftLint
[23]: https://www.objc.io/blog/2020/08/18/fuzzy-search/
[24]: https://github.com/apple/swift
[image-1]: Icons/GitHubBanner.png