tylerkneidl/monarq_home

MONARQ Companion Application

MONARQ is a lightweight NPM Package which expands your Express/GraphQL server to accept REST requests. This application contains a user friendly GUI to easily create the required Manifest Object. Due to the specification, here the user can take the guess work out of creating their own Manifest Obejct. Simply use the input fields, add to the accompanying object, then copy and paste the completed Manifest Object into your application.

Visit our website MONARQ.io to see the application code in action, create the Manifest Object, and learn more about the NPM Package.

Visit MONARQ's GitHub or MONARQ's NPM page for further information on MONARQ.

How To Use

Step 1:

Navigate to the Manifest Builder within MONARQ.io. Then press 'Get Started'.

Step 2:

Simply add your GraphQL URL to the first input box. This will allow for the application to access your schema which is integral to creating the Manifest Object.

Step 3:

Once your schema has loaded, declare the REST endpoints and the REST request method that will be open to the client. Select the query or mutation that will be run within these designated endpoints.

Then click "Add to Manifest"

Step: 4

Now your Manifest Object is populated with your inputs! Keep adding endpoints and/or methods that you want to open to the client sending REST Requests.

Step: 5

Once you have populated the Manifest Object with the desired endpoints and methods, copy and paste the code into a file within your application.

Step 6:

Import the Manifest Object into your top level server file and invoke the functions within MONARQ's NPM package. Pass in this created Manifest Object into both functions based on the instructions. Now you will not run the risk of having a Manifest Object that is incorrect.

Contributors

Peter Baniuszewicz @Peter-Ba

Amy Chen @designal46

Tyler Kneidl @tylerkneidl

Helen Regula @helenregula