https://github.com/tomyitav/create-graphql-app
Cli tool for bootstrapping serverless GraphQL api
https://github.com/tomyitav/create-graphql-app
apollo apollo-server aws-lambda cli code-generation graphql nodejs now-cli schema-first serverless typescript
Last synced: 7 months ago
JSON representation
Cli tool for bootstrapping serverless GraphQL api
- Host: GitHub
- URL: https://github.com/tomyitav/create-graphql-app
- Owner: tomyitav
- License: mit
- Created: 2018-11-21T00:20:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T03:36:17.000Z (about 1 year ago)
- Last Synced: 2024-10-30T06:24:52.139Z (about 1 year ago)
- Topics: apollo, apollo-server, aws-lambda, cli, code-generation, graphql, nodejs, now-cli, schema-first, serverless, typescript
- Language: TypeScript
- Homepage: https://medium.com/@tomyitav/serverless-graphql-api-using-gga-cli-39e1ec5a47a2
- Size: 6.44 MB
- Stars: 29
- Watchers: 4
- Forks: 0
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# create-graphql-app
[](https://travis-ci.org/tomyitav/generate-graphql-app)
[](https://coveralls.io/github/tomyitav/generate-graphql-app?branch=master)
[](https://www.npmjs.com/package/generate-graphql-app)
[](./LICENSE)
[](https://github.com/prettier/prettier)
[](https://github.com/semantic-release/semantic-release)
[![renovate-app badge][renovate-badge]][renovate-app]
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/
Cli tool for bootstrapping production grade GraphQL server, using:
+ typescript
+ apollo-server 2
+ [graphql-code-generator](https://github.com/dotansimha/graphql-code-generator)
+ merge-graphql-schemas
+ Dependency injection with `injection-js`
## Installation
Please make sure you have Node.js version 8+, and type
```npm install -g create-graphql-app```
## CLI commands
### Init server command
Open shell in the desired folder for bootstrapping the server, and typed:
```cga init ```
The command will prompt available server seeds options. Choose the boilerplate project
you want, and start coding!
### Generate server resolver files
The server boilerplate code is designed as multi file schema definitions.
Our recommended way for schema design is to create a type file for certain entity.
Eventually, all entities schemas are merged.
To generate a matching resolver file for type file, execute the command:
```cga r ```
This will create a matching file, with all Query, Mutation and Subscription
definitions.
### Generate services
Our server resolvers should operate as a thin layer, or controller, that links between the schema,
and the server business logic. We use *services* for our model, to perform logic such as api fetching,
db operations, etc. In order to create a new service, run the command:
```cga s [--ignoreContext]```
This will create a new service file to services directory. Also, it will register the service on the
server *injector* file, and will add its definition to the context object, thus allowing its usage
by resolvers.
You can exclude context file additions by passing the *ignoreContext* flag.
### Deploy server to production
Inside the project directory, type:
```cga d```
This will run the server *deploy* script, and will move the server to production! :rocket:
### Extended documentation
Please check out the [extended documentation](https://tomyitav.github.io/create-graphql-app) for more information