graphql-modules
Version:
Create reusable, maintainable, testable and extendable GraphQL modules
93 lines (60 loc) • 3.56 kB
Markdown
[](https://graphql.org/conf/2024/?utm_source=github&utm_medium=graphql_modules&utm_campaign=readme)
<!-- Uncomment when we remove GraphQL Conf banner -->
<!-- [](https://graphql-modules.com/) -->
[](https://www.npmjs.com/package/graphql-modules)
[](https://the-guild.dev/discord)
[]()
**GraphQL Modules** is a toolset of libraries and guidelines dedicated to **create reusable, maintainable, testable and extendable modules** out of your GraphQL server.
- [Website](https://graphql-modules.com)
- [Documentation](https://graphql-modules.com/docs)
## Highlights
- **Reusable modules** - Modules are defined by their GraphQL schema (Schema first design). They can be shared between apps.
- **Scalable structure** - Manage multiple teams and features, multiple micro-services and servers.
- **Gradual growth** - A clear, gradual path from a very simple and fast, single-file modules, to scalable multi-file, multi-teams, multi-repo, multi-server modules.
- **Testable** - A rich toolset around testing, mocking and separation.
## Documentation
Documentation is available at [graphql-modules.com](https://graphql-modules.com/docs).
## Installation
To install graphql-modules, use the following:
```sh
$ npm install graphql-modules
# Or, with Yarn
$ yarn add graphql-modules
```
#### Pre-release
We are also publishing a pre-release version to NPM on each change.
Just take a look at the build status on Github Actions and find "Publish Canary" job to get the published version.
## Usage
More advanced usage at [graphql-modules.com](https://graphql-modules.com/docs)
```js
import { createModule, createApplication, gql } from 'graphql-modules'
const module = createModule({
id: 'my-module',
typeDefs: gql`
type Post {
id: ID
title: String
author: User
}
type Query {
posts: [Post]
}
`,
resolvers: blogResolvers
})
const application = createApplication({
modules: [module]
})
```
Inside the `examples` directory you can find the following examples:
- [Simple GraphQL-Modules example](./examples/basic)
- [Using dependency injection in GraphQL Modules](./examples/basic-with-dependency-injection)
## Contributions
Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!
And if this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off.
### Code of Conduct
Help us keep GraphQL Modules open and inclusive. Please read and follow our [Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/)
### License
[](https://raw.githubusercontent.com/apollostack/apollo-ios/master/LICENSE)
MIT