Git Product home page Git Product logo

backend's Introduction

Boilerplate for a Minimal GraphQL Server w/ TypeScript


๐Ÿš€ Bootstrap your GraphQL server within seconds
Minimal starter kit for a flexible GraphQL server for TypeScript - based on best practices from the GraphQL community.

Features

  • Scalable GraphQL server: The server uses graphql-yoga which is based on Apollo Server & Express
  • Tooling: Out-of-the-box support for GraphQL Playground & query performance tracing
  • Simple Hello World example: Where it either returns Hello <name>! or Hello World! if no name argument is provided.
  • No configuration overhead: Preconfigured graphql-config setup

Read more 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 `typescript-basic` boilerplate
graphql create my-app --boilerplate typescript-minimal

# 2. Run yarn install or npm install

# 3. Navigate to the new project
cd my-app

# 4. Start server (runs on http://localhost:4000) and open GraphQL Playground
yarn dev

Documentation

Commands

  • yarn start or npm run start starts GraphQL server on http://localhost:4000
  • yarn dev or npm run dev starts GraphQL server on http://localhost:4000 and opens GraphQL Playground

Project structure

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

โ””โ”€โ”€ src (directory) Contains the source files for your GraphQL server
ใ€€ใ€€โ”œโ”€โ”€ index.ts The entry point for your GraphQL server

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.

backend's People

Contributors

mariamab avatar

Watchers

James Cloos 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.