├── package.json
├── .DS_Store
├── orph-gif
├── query.gif
├── history.gif
└── historyquery.gif
├── context.js
├── index.js
├── extension.js
├── LICENSE
├── .gitignore
├── README.md
└── orpheus.js
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "orpheus-gql",
3 | "version": "1.0.7"
4 | }
--------------------------------------------------------------------------------
/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orpheus-gql/orpheus-dist/HEAD/.DS_Store
--------------------------------------------------------------------------------
/orph-gif/query.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orpheus-gql/orpheus-dist/HEAD/orph-gif/query.gif
--------------------------------------------------------------------------------
/orph-gif/history.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orpheus-gql/orpheus-dist/HEAD/orph-gif/history.gif
--------------------------------------------------------------------------------
/orph-gif/historyquery.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orpheus-gql/orpheus-dist/HEAD/orph-gif/historyquery.gif
--------------------------------------------------------------------------------
/context.js:
--------------------------------------------------------------------------------
1 | var context = () => {
2 | return {
3 | startTime: Date.now()
4 | }
5 | }
6 |
7 | module.exports = context;
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | var context = require('./context');
2 | var extension = require('./extension');
3 | var config = require('./orpheus');
4 |
5 | module.exports = { context, extension, config };
6 |
--------------------------------------------------------------------------------
/extension.js:
--------------------------------------------------------------------------------
1 | var extension = ({ context }) => {
2 | var runTimeResult = Date.now() - context.startTime;
3 | return {
4 | runTime: runTimeResult
5 | }
6 | }
7 |
8 | module.exports = extension;
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2019 Orpheus GQL
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 |
8 | # Runtime data
9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 |
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 |
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 |
20 | # nyc test coverage
21 | .nyc_output
22 |
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 |
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 |
29 | # node-waf configuration
30 | .lock-wscript
31 |
32 | # Compiled binary addons (https://nodejs.org/api/addons.html)
33 | build/Release
34 |
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 |
39 | # TypeScript v1 declaration files
40 | typings/
41 |
42 | # Optional npm cache directory
43 | .npm
44 |
45 | # Optional eslint cache
46 | .eslintcache
47 |
48 | # Optional REPL history
49 | .node_repl_history
50 |
51 | # Output of 'npm pack'
52 | *.tgz
53 |
54 | # Yarn Integrity file
55 | .yarn-integrity
56 |
57 | # dotenv environment variables file
58 | .env
59 |
60 | # next.js build output
61 | .next
62 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Orpheus GQL
2 |
3 | ## Download
4 | ```
5 | npm i orpheus-gql
6 | ```
7 |
8 | ## Installation
9 |
10 | 1. Import OrpheusGQL into your app
11 | 2. Configure Orpheus with your endpoint URL
12 | 3. Navigate to '/orpheus' to use the GUI
13 |
14 | ``` javascript
15 | const graphqlHTTP = require('express-graphql');
16 | const orpheus = require('orpheus-gql');
17 | const orph = orpheus.config('http://localhost:[your-port]/[graphql endpoint]');
18 |
19 | app.use('/graphql', graphqlHTTP(request=>{
20 | return {
21 | schema,
22 | context: orpheus.context(),
23 | graphiql: true,
24 | extensions: orpheus.extension
25 | }
26 | }))
27 |
28 | app.get('/orpheus', orph)
29 | ```
30 | ## Usage
31 |
32 | 1. Enter your JavaScript GraphQL query in the code editor on the left
33 | 
34 |
35 | 2. Click Run
36 |
37 | 3. Results will be displayed visually on the graph; scalar values can be viewed below the graph
38 |
39 | 4. Center of the graph represents entry point into your database
40 |
41 | 5. Queries that return multiple items will be represented numerically
42 |
43 | 6. Labels will be given to each resolver of the item
44 |
45 | 7. History button will reveal archived queries
46 | displayed in descending order (with the most recent query at the top position)
47 | 
48 |
49 | 8. Clicking on a previous query will populate the code editor for it to be executed
50 | 
51 |
--------------------------------------------------------------------------------
/orpheus.js:
--------------------------------------------------------------------------------
1 | const renderOrpheusGQL = (uri) => {
2 | return `
3 |
4 |
5 |
6 |
7 |
8 | Orpheus GQL
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 | `
35 | }
36 |
37 | const config = (uri) => {
38 | return (request, response) => {
39 | response.set('Content-Type', 'text/html')
40 | response.send(renderOrpheusGQL(uri));
41 | }
42 | }
43 |
44 | module.exports = config;
45 |
--------------------------------------------------------------------------------