|
| 1 | +<p align="center"><img src="./build-res/icon.png" style="margin-top: 10px; margin-bottom: -10px;"></p> |
| 2 | + |
| 3 | +# |
| 4 | + |
| 5 | +[](https://github.com/open-source-labs/Swell/blob/master/LICENSE.txt) |
| 6 | +[](https://travis-ci.org/open-source-labs/Swell) |
| 7 | + |
| 8 | +[](https://github.com/getswell/getswell/issues) |
| 9 | +[](https://twitter.com/intent/tweet?text=Swell-%20For%20all%20your%20streaming%20API%20testing%20needs&url=https://www.getswell.io&hashtags=SSE,WebSocket,HTTP,API,developers) |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +# QLens |
| 14 | + |
| 15 | +QLens — See your GraphQL Schemas materialize before your eyes! |
| 16 | + |
| 17 | +Accelerated by [OS Labs](https://github.com/oslabs-beta/) |
| 18 | + |
| 19 | +## Getting Started |
| 20 | +Download QLens onto your desktop by going to [www.qlensapp.com](https://www.qlensapp.com) |
| 21 | + |
| 22 | +## Features |
| 23 | +* GraphQL schema (including resolvers, and mutations) |
| 24 | +* Visual interactive diagram of Hierarchy Display |
| 25 | +* Download Schemas |
| 26 | +* GraphQL's Playground GUI |
| 27 | + |
| 28 | +## How does QLens work? |
| 29 | + |
| 30 | + |
| 31 | +## 1. Enter URI |
| 32 | +Simply enter your non-relational database (MongoDB) URI in the input form at the top of the screen and press enter. You will see a dropdown menu on the left hand side of the screen revealing all of your database schemas. Click the schemas you would like converted to GraphQL and then click the ‘Add Selected Schemas’ button. |
| 33 | + |
| 34 | +Please see below gif to reset the URI: |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +## Hierarchy Display: |
| 39 | +The first thing you’ll notice in the center of the screen is a graph displayed to visualize the hierarchy of your non-relational database schemas in a tree-like structure. |
| 40 | + |
| 41 | +## 2. Select GraphQL Schemas |
| 42 | +On the right side of the screen is where your life just got a whole lot easier. You will find your GraphQL schema boilerplate already entirely formatted for your project complete with resolvers and mutations. At the top of the text editor, you will see a tab to toggle to see your MongoDB schemas in their own editor. Here is where you can either copy your GraphQL schemas and paste right into your code editor, or click the download button. <br><br> |
| 43 | + |
| 44 | +## 3. Download Schemas |
| 45 | +Click the Download Schemas button at the bottom of the code editor and the GraphQL schema code will download into a folder on your desktop. Drag the folder into your preferred code editor and voilà! Formatted GraphQL schemas right there in your code editor! It’s that easy! <br><br> |
| 46 | + |
| 47 | +## 4. GraphQL Playground |
| 48 | +Back in QLens, you can see your GraphQL schemas in action by clicking on the Playground button at the top right-hand side of the screen which will take you to GraphQL’s very own integrated development environment, GraphiQL where you can make queries and test your code. <br><br> |
| 49 | + |
| 50 | +## How To Contribute |
| 51 | +We would love for you to test our application and submit any issues you encouter. Please feel free to fork your own repository to and submit your own pull requests. |
| 52 | + |
| 53 | +## Built With |
| 54 | + |
| 55 | +- Electron |
| 56 | +- React |
| 57 | +- Codemirror |
| 58 | +- Jest |
| 59 | +- Node.js |
| 60 | +- Express |
| 61 | +- Graphiql |
| 62 | +- Graphql |
| 63 | +- lodash |
| 64 | +- Babel |
| 65 | +- Webpack |
| 66 | +- Enzyme |
| 67 | +- React-Testing-Library |
| 68 | +- spectron |
| 69 | + |
| 70 | +How you can contribute: |
| 71 | +* Bug fixes |
| 72 | +* Implementing features |
| 73 | +* Submitting or resolving GitHub issues |
| 74 | +* Help market our application |
| 75 | +## Developers |
| 76 | +* [Steven LaBrie](https://github.com/danieldolich) |
| 77 | +* [Judy Tan](https://github.com/Judanator) |
| 78 | +* [Cho Yee Win Aung](https://github.com/choyeewinag) |
| 79 | +* [Jake Diorio](https://github.com/stevenlabrie) |
| 80 | + |
| 81 | +## License |
| 82 | +This project is licensed under the MIT License |
0 commit comments