Giter VIP home page Giter VIP logo

preset's Introduction

Boilerplate for a Basic Fullstack GraphQL App with React


๐Ÿš€ Bootstrap your fullstack GraphQL app within seconds
Basic starter kit for a fullstack GraphQL app with React and Node.js - based on best practices from the GraphQL community.

Features

  • Scalable GraphQL server: The server uses graphql-yoga which is based on Apollo Server & Express
  • Pre-configured Apollo Client: The project comes with a preconfigured setup for Apollo Client
  • GraphQL database: Includes GraphQL database binding to Prisma (running on MySQL)
  • Tooling: Out-of-the-box support for GraphQL Playground & query performance tracing
  • Extensible: Simple and flexible data model โ€“ easy to adjust and extend
  • No configuration overhead: Preconfigured graphql-config setup

For a fully-fledged React & Apollo tutorial, visit How to GraphQL. You can more learn about the idea behind GraphQL boilerplates here.

Requirements

You need to have the GraphQL CLI installed to bootstrap your GraphQL server using graphql create:

npm install -g graphql-cli

Getting started

# 1. Bootstrap GraphQL server in directory `my-app`, based on `react-fullstack-basic` boilerplate
graphql create my-app --boilerplate react-fullstack-basic

# 2. When prompted, deploy the Prisma service to a _public cluster_

# 3. Navigate into the `server` directory of the new project
cd my-app/server

# 4. Start the server
yarn start # the server is now running on http://localhost:4000

# 5. Open a new tab in the terminal and navigate back into my-app;
# then run the app
cd ..
yarn start

# 6. Open http://localhost:4000 in your browser

Documentation

Commands

  • yarn start starts GraphQL server on http://localhost:4000
  • yarn dev starts GraphQL server on http://localhost:4000 and opens GraphQL Playground
  • yarn playground opens the GraphQL Playground for the projects from .graphqlconfig.yml
  • yarn prisma <subcommand> gives access to local version of Prisma CLI (e.g. yarn prisma deploy)

Note: We recommend that you're using yarn dev during development as it will give you access to the GraphQL API or your server (defined by the application schema) as well as to the Prisma API directly (defined by the Prisma database schema). If you're starting the server with yarn start, you'll only be able to access the API of the application schema.

Server structure

File name ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ Description ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€ใ€€

โ”œโ”€โ”€ .graphqlconfig.yml Configuration file based on graphql-config (e.g. used by GraphQL Playground).
โ””โ”€โ”€ database (directory) Contains all files that are related to the Prisma database service
ใ€€ใ€€โ”œโ”€โ”€ prisma.yml The root configuration file for your Prisma database service (docs)
ใ€€ใ€€โ””โ”€โ”€ datamodel.graphql Defines your data model (written in GraphQL SDL)
โ””โ”€โ”€ src (directory) Contains the source files for your GraphQL server
ใ€€ใ€€โ”œโ”€โ”€ index.js The entry point for your GraphQL server
ใ€€ใ€€โ”œโ”€โ”€ schema.graphql The application schema defining the API exposed to client applications
ใ€€ใ€€โ””โ”€โ”€ generated (directory) Contains generated files
ใ€€ใ€€ใ€€ใ€€โ””โ”€โ”€ prisma.grapghql The Prisma database schema defining the Prisma GraphQL API

Contributing

The GraphQL boilerplates are maintained by the GraphQL community, with official support from the Apollo & Graphcool teams.

Your feedback is very helpful, please share your opinion and thoughts! If you have any questions or want to contribute yourself, join the #graphql-boilerplate channel on our Slack.

Run introspection query

{
  __schema {
    types {
      kind
      name
      interfaces {
        name
        description
      }
    }
  }
}
{
  __type(name: "Film") {
    name
    fields {
      name
      description
      type {
        name
        kind
        ofType {
          name
          kind
          ofType {
            name
            kind
          }
        }
      }
      args {
        name
        description
        defaultValue
        type {
          name
          kind
          ofType {
            name
          }
        }
      }
    }
  }
}

preset's People

Contributors

hribb avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.