Skip to content

Latest commit

 

History

History
84 lines (49 loc) · 4.34 KB

README.md

File metadata and controls

84 lines (49 loc) · 4.34 KB
Raw

ProtoGraphQL ver. 2.0

*** The latest release of ProtoGraphQL includes a new view that can jumpstart your query testing with the Jest framework and the ability to import tables from an existing database. ***

ProtoGraphQL is a prototyping tool that empowers developers to build and visualize GraphQL schemas and queries without writing any code. Once users import or input their relational database tables, ProtoGraphQL can generate an export package that allows developers to spin up a customized and functional GraphQL Apollo Server as an independent app. (As of version 2.0 custom mutations are also supported!)

ProtoGraphQL is in beta. Please post any issues to our GitHub - we are actively looking for opportunities to improve this tool and we welcome your feedback.

Upcoming releases will improve the “Schema” view and add support for NoSQL databases.

Getting Started:

  1. Download: Mac, Windows, Linux

  2. Extract file

  3. Run application

How to Use:

  1. When the application starts you will be given the option to either CREATE YOUR TABLES or IMPORT TABLES. To create your tables, click the “Add Table” button in the lower left corner of the screen. When your config is complete, click Save. When importing, simply paste your database URI in the field and click the Connect button. In either case, your tables will be displayed in the main view when you are done.

  1. Navigate to the alternate views within the app using the tabs on the left: Schema, Code, Visualize, and Tests

  • Schema - view, edut or delete tables you've added.

  • Code - view generated GraphQL and SQL code.

  • Visualize - view the GraphQL schema as a simple tree.

  • Tests - create and export query and response pairs from a custom GraphQL Endpoint.

  1. Export your code by clicking the Export icon in the upper right.

  1. Enter your Postgres database URI, then select the directory you want to save your compressed GraphQL server package in.

How to Run GraphQL Server:

There are several libraries we could have used to create a GraphQL server, but we decided to use Apollo Server – the most popular library to setup an endpoint for responding to incoming GraphQL requests in JavaScript.

  1. Extract apollo-server.zip file

  2. Open the project

  3. Install dependencies

npm install
  1. Run the server and point your browser to localhost:3000
npm start
  1. Use Apollo Server Playground to mock client GraphQL queries and responses to your server. Learn more about constructing GraphQL Queries here

Contributors: