Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oslabs-beta/qlens

QLens is an electron app which dynamically generates GraphQL Schemas and Mongo Schema visualization. QLens significantly cuts development time by automating the formation of their GraphQL schemas based on information fetched from their non-relational database.
https://github.com/oslabs-beta/qlens

codemirror electron electron-app electron-builder enzyme-adapter-react-16 enzyme-testing graphql graphql-client graphql-server graphql-tools jest-tests nosql nosql-database react

Last synced: about 1 month ago
JSON representation

QLens is an electron app which dynamically generates GraphQL Schemas and Mongo Schema visualization. QLens significantly cuts development time by automating the formation of their GraphQL schemas based on information fetched from their non-relational database.

Awesome Lists containing this project

README 

        



#



[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/open-source-labs/Swell/blob/master/LICENSE.txt)

[![Build Status](https://travis-ci.org/open-source-labs/Swell.svg?branch=master)](https://travis-ci.org/open-source-labs/Swell)

![GitHub package.json version](https://img.shields.io/github/package-json/v/open-source-labs/Swell?color=blue)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/getswell/getswell/issues)

[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](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)



# QLens 



Using GraphQL with MongoDB can cause data mismatch and schema duplication requiring developers to write similar code multiple times. This can significantly slow down development time. In addition, there aren't many libraries that tackle MongoDB conversion to GraphQL schemas. Most libraries tackling this issue are focused on relational databases. QLens solves that problem. 



QLens — Open source tool to extract metadata from your MongoDB database to generate GraphQL schemas, resolvers and server setup.



Accelerated by [OS Labs](https://github.com/oslabs-beta/)



## Getting Started

1. Globally install extract mongo schema on your machine: npm -g install extract-mongo-schema

2. Download QLens onto your desktop by going to  [www.qlensapp.com](http://qlensapp.com)



## Features

* GraphQL schema (including resolvers, and mutations) 

* Visual interactive diagram of Hierarchy Display

* Download Schemas

* GraphQL's Playground GUI



## How does QLens work? 

![QLens.gif](./gif/qlens.gif)



## 1. Enter URI

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. 



![QLens.gif](./gif/pastingURI.gif)



Please see below gif to reset the URI:



![QLens.gif](./gif/reset.gif)



## 2. Select GraphQL Schemas

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. 




## 3. Download Schemas

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! 




## 4. Playground:

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.



![QLens.gif](./gif/playground.gif)



## How To Contribute

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.



## Built With



- Electron

- React

- Codemirror

- Jest

- Node.js

- Express

- Graphiql

- Graphql

- Lodash

- Babel

- Webpack

- Enzyme

- React-Testing-Library

- Spectron



How you can contribute: 

* Bug fixes

* Implementing features

* Submitting or resolving GitHub issues

* Help market our application

## Developers

* [Steven LaBrie](https://github.com/stevenlabrie)

* [Judy Tan](https://github.com/Judanator)

* [Cho Yee Win Aung](https://github.com/choyeewinag)

* [Jake Diorio](https://github.com/jdiorio2393)



## License

This project is licensed under the MIT License



## Upcoming Features 

Currently QLens does not support playground functionality and has limited functionality for creating resolvers. Currently we are working on implementing the following features: 

* Playground functionality for testing queries and mutations 

* Generating mutations for updating 

* Generating resolvers for Mongo documents with "ref" or foreign keys 

* Allowing for conversion of SQL databases