sergiodxa / grial

A Node.js framework for creating GraphQL API servers easily and without a lot of boilerplate.

Grial

A Node.js framework for creating GraphQL API servers easily and without a lot of boilerplate.

Why?

There's a lot of boilerplate code required to run a GraphQL API with Node.js, the server code it's almost always the same, create a server, load the resolvers and the schema and set the /graphql endpoint along with GraphiQL.

Grial allow you to only think about your business logic and API and is responsible for implementing the boilerplate code for you.

Grial also provide you with connectors you can use to consume many data sources easily.

Documentation

You can check the Grial docs in the repository wiki

grial's Issues

Allow @grial/server context customization

Right now it's impossible to customize the context of each request in @grial/server, I want it to be customizable somehow. Also allow the customization of the WS server context.

Implement @grail/connector-mysql

Implement a connector for the mysql driver.

[request] Authentication/authorization example

Guys, thank you for a great tool! Can we use Grial for production or is it a beta soft?
What would be the recommended way to handle authentication/authorization?
A tutorial would be much appreciated, perhaps using https://github.com/nmaro/ooth or https://github.com/kkemple/graphql-auth for example.

Test Grial

Right now the code is not tested, we need at least the @grial/server and @grial/utils packages tested.

Test @grial/connector-rethinkdb

Test the @grial/connector-rethinkdb to be sure it works

Implement @grial/connector-pg

Implement a connector for the PostgreSQL driver.

Have an integrated test enviroment

It could be a good idea to have Jest or another testing framework integrated in the CLI so you don't need to do it manually.

Cache DB connection

Thanks for the awesome framework!
Could we save the connection to databases to reuse in other parts of the application?
Something like:

const MongoClient = require("mongodb");

const connectionCache = {};

async function mongodb(URL) {
  if (connectionCache[URL]) return connectionCache[URL];

  const connectionPromise = new Promise((resolve, reject) => {
    MongoClient.connect(URL, (error, connection) => {
      if (error) return reject(error);
      resolve(connection);
    });
  });

  connectionCache[URL] = connectionPromise;
  return connectionPromise;
}

exports.mongodb = mongodb;

remove file extension from required files

By removing the file extension from the import of e.g.resolvers.js we'd be able to import resolvers.js or resolvers/index.js which acts as an entry point and reexports all resolvers.
I've seen that you have basically implemented the same concept for schema.ggl|grapgl and files within the schemas/*.ggl|graphql folder and it's a common concept to structure your application.

I'll help with a implementation in the future, just let me know what do you think…

Publish @grial/connector-rethinkdb

If it works, publish the RethinkDB connector.

Can't follow the CONTRIBUTING guidelines

Hi,
I just wanted to warn you that we can't foloow step 4 from the CONTRIBUTING.md
There is no 'build' script in package.json.
What is the best way to do it?
Bye

Implement Hot Reload for development

In development the server should implement the Hot Reload.

Lodash dependency

Just a quick heads up:
followed all steps in the tutorial on Medium but kept getting error even after removing /node_modules and reinstalling dependencies:

> grial start
module.js:487
    throw err;
    ^
Error: Cannot find module 'lodash'
    at Function.Module._resolveFilename (module.js:485:15)

Only yarn add lodash resolved this issue and everything worked according to the tutorial.
Is this a correct behavior or should the Grial server work without loading the whole Lodash lib?

404 Not Found: @grial/cli@latest

Hi, i'm very interested in your project, but unfortunately can't try it out due to the error i'm getting from npm install (other packages are installed fine on the same machine).
Any idea how to fix the problem?

create-grial-api

Create a CLI tool that follow the create-* name convention to start new projects with Grial and have the default files and some test files.