https://github.com/kettanaito/graphql-mongo

Utilities for faster GraphQL + MongoDB integration.
https://github.com/kettanaito/graphql-mongo

graphql graphql-mongo mongodb mongoose strongly-typed typed

Last synced: 13 days ago
JSON representation

Utilities for faster GraphQL + MongoDB integration.

• Host: GitHub
• URL: https://github.com/kettanaito/graphql-mongo
• Owner: kettanaito
• Created: 2017-10-13T08:46:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-15T07:54:40.000Z (about 7 years ago)
• Last Synced: 2024-05-22T16:24:21.930Z (7 months ago)
• Topics: graphql, graphql-mongo, mongodb, mongoose, strongly-typed, typed
• Language: JavaScript
• Homepage:
• Size: 92.8 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

    

  



GraphQL Mongo


## Introduction

This library is meant to make it easier and faster to get started using GraphQL with your existing MongoDB setup.

## API

| Class | Description |

| - | ----------- |

| `GraphQLDocument` | Wraps mongoose Schema definition, GraphQL queries/mutations/subscriptions into a managable Object, allowing easier GraphQL types composition and referencing. |

## Usage example

There is a minimal example of usage included within the library. Please see its [source code](./example) or run it locally on your machine by following the instructions below:

1. Fork the repository.

1. Install the dependencies with `npm install`.

2. Run `npm start` from the repository directory. This will create a simple Express server with the connection to the test Mongo database.

3. Navigate to [http://localhost:8040](http://localhost:8040). Play around with GraphQL using an incredible GraphiQL IDE.

## Special thanks

* [express-graphql](https://github.com/graphql/express-graphql). Easy way to establish a GraphQL end-point in your Express server.

* [mongoose-schema-to-graphql](https://github.com/sarkistlt/mongoose-schema-to-graphql). Responsible for converting mongoose Schema to GraphQL types.