xblaster/ambianceur-b repository overview
Boilerplate for an Advanced GraphQL Server w/ TypeScript
Features
- Scalable GraphQL server: The server uses
graphql-yoga which is based on Apollo Server & Express - Static type generation: TypeScript types for GraphQL queries & mutations are generated in a build step
- Authentication: Signup and login workflows are ready to use for your users
- 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 - Realtime updates: Support for GraphQL subscriptions
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-advanced` boilerplate
graphql create my-app --boilerplate typescript-advanced
# 2. When prompted, deploy the Prisma service to a _public cluster_
# 3. Navigate to the new project
cd my-app
# 4. Start server (runs on http://localhost:4000) and open GraphQL Playground
yarn start
Documentation
Commands
yarn startstarts GraphQL server onhttp://localhost:4000yarn prisma <subcommand>gives access to local version of Prisma CLI (e.g.yarn prisma deploy)
Note: We recommend that you're using
yarn devduring 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 withyarn start, you'll only be able to access the API of the application schema.
Project structure
| File name | Description |
|---|---|
├── .env | Defines environment variables |
├── .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.ts | The entry point for your GraphQL server |
├── schema.graphql | The application schema defining the API exposed to client applications |
├── resolvers (directory) | Contains the implementation of the resolvers for the application schema |
└── generated (directory) | Contains generated files |
└── prisma-client (directory) | The generated Prisma client |
Contributing
The GraphQL boilerplates are maintained by the GraphQL community, with official support from the Apollo & Prisma 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.
Tag summary
Content type
Image
Digest
Size
462.8 MB
Last updated
over 7 years ago
docker pull xblaster/ambianceur-b