Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nikolasburk/gc-migration-auth-example


https://github.com/nikolasburk/gc-migration-auth-example

Last synced: 25 days ago
JSON representation

Awesome Lists containing this project

README 

        
# node-advanced



🚀 Advanced starter code for a scalable, production-ready GraphQL server for Node.js, including authentication and realtime functionality with GraphQL subscriptions.



![](https://imgur.com/LG6r1q1.png)



## Features



- **Scalable GraphQL Server:** `graphql-yoga` based on Apollo Server & Express

- **GraphQL-native database:** Includes GraphQL database binding to Graphcool (running on MySQL)

- Out-of-the-box support for [GraphQL Playground](https://github.com/graphcool/graphql-playground) & [Tracing](https://github.com/apollographql/apollo-tracing)

- Simple data model – easy to adjust

- Preconfigured [`graphql-config`](https://github.com/graphcool/graphql-config) setup

- Authentication based on email & password

- Realtime functionality with GraphQL subscriptions (_coming soon_)



## Requirements



You need to have the following things installed:



* Node 8+

* Graphcool CLI: `npm i -g graphcool@beta`

* GraphQL CLI: `npm i -g graphql-cli`

* GraphQL Playground desktop app (optional): [Download](https://github.com/graphcool/graphql-playground/releases)



## Getting started



```sh

# Bootstrap GraphQL server in directory `my-app`, based on `node-advanced` boilerplate

graphql create my-app --boilerplate node-advanced



# Navigate to the new project

cd my-app



# Deploy the Graphcool database

graphcool deploy



# Start server (runs on http://localhost:4000)

yarn start



# Open Playground to explore GraphQL API

yarn playground

```



Alternative: Clone repo



```sh

# Clone the repo and navigate into project directory

git clone https://github.com/graphql-boilerplates/node-graphql-server.git

cd node-graphql-server/advanced



# Deploy the Graphcool database

graphcool deploy



# Install node dependencies

yarn install



# Start server (runs on http://localhost:4000)

yarn start



# Open Playground to explore GraphQL API

yarn playground

```



## Docs



### Commands



* `yarn start` starts GraphQL server

* `yarn debug` starts GraphQL server in debug mode (open [chrome://inspect/#devices](chrome://inspect/#devices) to debug)

* `yarn playground` opens the GraphQL Playground

* `yarn build` builds the application

* `yarn deploy` deploys GraphQL server to [`now`](https://now.sh)



### Project structure



#### `/` (_root directory_)



- [`.env`](./.env) Contains important environment variables for development. Read about how it works [here](https://github.com/motdotla/dotenv).

- [`.graphqlconfig.yml`](./.graphqlconfig.yml) GraphQL configuration file containing the endpoints and schema configuration. Used by the [`graphql-cli`](https://github.com/graphcool/graphql-cli) and the [GraphQL Playground](https://github.com/graphcool/graphql-playground). See [`graphql-config`](https://github.com/graphcool/graphql-config) for more information.

- [`graphcool.yml`](./graphcool.yml): The root configuration file for your database service ([documentation](https://www.graph.cool/docs/1.0/reference/graphcool.yml/overview-and-example-foatho8aip)).



#### `/database`



- [`database/datamodel.graphql`](./database/datamodel.graphql) contains the data model that you define for the project (written in [SDL](https://blog.graph.cool/graphql-sdl-schema-definition-language-6755bcb9ce51)).

- [`database/schema.generated.graphql`](./database/schema.generated.graphql) defines the **database schema**. It contains the definition of the CRUD API for the types in your data model and is generated based on your `datamodel.graphql`. **You should never edit this file manually**, but introduce changes only by altering `datamodel.graphql` and run `graphcool deploy`.



#### `/src`



- [`src/schema.graphql`](src/schema.graphql) defines your **application schema**. It contains the GraphQL API that you want to expose to your client applications.

- [`src/index.js`](src/index.js) is the entry point of your server, pulling everything together and starting the `GraphQLServer` from [`graphql-yoga`](https://github.com/graphcool/graphql-yoga).

- [`src/resolvers/`](src/resolvers) contains the actual business logic of your application. In GraphQL, you implement [resolver functions](http://graphql.org/learn/execution/) that *resolve* a specific query being requested.



### Common questions



#### I'm getting a 'Schema could not be fetched.' error after deploying, what gives?



Access to the Graphcool API is secured by a secret. This also applies to the introspection query. Using the latest version of GraphQL Playground, the `Authorization` header should automatically be setup with a proper JWT signing the secret. If that's not the case, you can follow these steps to access your API:



1. Visit http://jwtbuilder.jamiekurtz.com/

1. Replace the `Key` at the bottom of the page with [your secret from the `.env` file](https://github.com/graphcool/graphql-boilerplate/blob/master/.env#L3)

1. Click `Create signed JWT` and copy the obtained token

1. Now, to access the schema, use the `Authorization: Bearer ` header, or in the GraphQL Playground set it as JSON:

    ```json

    {

      "Authorization": "Bearer "

    }

    ```

1. Reload the schema in the Playground (the _refresh_-button is located right next to the URL of the server)



> Note: Currently, no content of the signed JWT is verified by the database! This will be implemented [according to this proposal](https://github.com/graphcool/framework/issues/1365) at a later stage.



## Contributing



Your feedback is **very helpful**, please share your opinion and thoughts! If you have any questions, join the [`#graphql-boilerplate`](https://graphcool.slack.com/messages/graphql-boilerplate) channel on our [Slack](https://graphcool.slack.com/).