https://github.com/dhruv-kumar-jha/graphql-doc

GraphQL Documentation Generator
https://github.com/dhruv-kumar-jha/graphql-doc

antd axios create-react-app lodash react react-router webpack

Last synced: about 3 hours ago
JSON representation

GraphQL Documentation Generator

• Host: GitHub
• URL: https://github.com/dhruv-kumar-jha/graphql-doc
• Owner: dhruv-kumar-jha
• Created: 2017-11-19T06:18:47.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T18:13:31.000Z (almost 2 years ago)
• Last Synced: 2023-03-21T10:30:42.767Z (over 1 year ago)
• Topics: antd, axios, create-react-app, lodash, react, react-router, webpack
• Language: JavaScript
• Homepage: https://graphql-doc-generator.firebaseapp.com/
• Size: 1.65 MB
• Stars: 43
• Watchers: 2
• Forks: 9
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GraphQL Doc

Generate Documentation for GraphQL Endpoints Instantly.

![ScreenShot](public/screenshot.png)

This application was inspired by **GraphiQL**, It categorizes all the Types, Queries, Mutations, Subscriptions in the way we code it, Making it easier for us to use and debug GraphQL Server Schemas.

We can easily filter through entire schema to find a single type/query/mutation/subscription we're looking for., I hope this will be beneficial to some as this has been beneficial to me.

## Installation

Just clone this repo and then run

```javascript

$ yarn install // or npm install

```

to install all the dependencies.

### After installing the dependencies

1. Run `yarn build` to make a production build of the application.

2. Now you can host the `build` directory wherever you want, I have used `firebase` but you can easily use **AWS**, **Netlify**, **Github Pages**, etc

## Feature Requests

I have few ideas on how to take this project forward and make it more useful to the users, However I'm very open to feature requests.

If you have any specific feature in mind which you think might be helpful to the community as well, Just `Create a New Issue` or `Get In Touch` with me.