Name: serverless-graphql
Owner: Serverless
Description: Serverless GraphQL Boilerplate using Apollo ? Ready to be deployed to production within minutes ?
Created: 2016-02-25 17:10:04.0
Updated: 2018-01-18 14:34:13.0
Pushed: 2018-01-09 06:33:35.0
Homepage: https://www.serverless.com
Size: 9130
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This starter kit is an opinionated set of tools combined to help you get started building a Serverless application with an GraphQL endpoint and deploy them to production in minutes.
This example uses the following technologies:
Frontend
Backend
AWS AppSync DynamoDB, Elasticsearch and Lambda Integrations
Plugins
Other Utilities and Integrations
You need to have Node 6 or higher installed.
install -g serverless
install -g yarn
install -g netlify-cli
Install Dependencies.
install
Please note: AWS CLI is required to be installed on your system
Select Backend
AWS Appsync (Serverless Offline does not support Appsync at this point)
Lambda Backend (Serverless Offline Supported)
Twitter Rest API
pp-backend/rest-api
start
DynamoDB
pp-backend/dynamodb
start
RDS
pp-backend/rds
start
Start FrontEnd (Apollo Client or Appsync Client)
For Appsync Backend please select Appsync Client Integration:
pp-client/appsync-client/
start
For Lambda Backend please select Apollo Client Integration:
pp-client/apollo-client/
start
Also, please make sure GraphQL endpoint is configured correctly in config/security.env.local to run client on local.
Start GraphiQL
://localhost:4000/graphiql
Start GraphQL Playground (GraphiQL replacement - coming soon)
://localhost:4000/playground
Configure your AWS keys. Here you can find a 2min walkthrough how to do retrieve the keys.
config credentials --provider aws --key <your_aws_access_key> --secret <your_aws_secret_key>
You need to make sure you have access to your deployed lambda functions.
Select Backend
AWS Appsync (Serverless Offline does not support Appsync at this point)
To use aws appsync you will need to create cognito user pool to authenticate the API Reference
- *AWS DynamoDB*
cd app-backend/appsync/dynamodb
yarn deploy-prod
Please make sure:
1. account_id is configured in package.json
2. graphQLAPIName, userPoolId and accountId are configured in deploy-dynamo.js
node deploy-dynamo.js
- AWS ElasticSearch
cd app-backend/appsync/elasticsearch
yarn deploy-prod
Please make sure:
1. account_id is configured in package.json
2. graphQLAPIName, userPoolId, accountId and esHostname are configured in deploy-elasticsearch.js
node deploy-elasticsearch.js
- AWS Lambda
cd app-backend/appsync/lambda
yarn deploy-prod
Please make sure:
1. account_id is configured in package.json
2. graphQLAPIName, userPoolId and accountId are configured in deploy-lambda.js
node deploy-lambda.js
Lambda Backend (Serverless Offline Supported)
Twitter Rest API
pp-backend/rest-api
deploy-prod
DynamoDB
pp-backend/dynamodb
deploy-prod
RDS
Create RDS Instance. For example - PostGres Tutorial
Please make sure connectivity to production RDS instance works (For example: test via razersql)
Edit the config/security.env.prod file and replace the DATABASE_URL variable with your amazon rds endpoint (eg: postgres://${username}:{password}@${endpoint):5432/${dbName}).
Run the deployment command
app-backend/rds
rn deploy-prod
Config: Get your /graphql POST endpoint as shown below and use it in config/security.env.prod
Select Frontend (apollo-client or appsync-client)
Note:
AWS S3
First you will need to choose custom s3 bucket name for client. For ex: s3-firstname-serverless-graphql. Please note that bucket name must be unique across all aws buckets.
Now, in app-client/<client-name>/serverless.yml edit the custom.client.bucketName property and replace it the bucket name above.
Now, in app-client/<client-name>/package.json edit the homepage property with https://${yourBucketName}.s3-website-us-east-1.amazonaws.com. For ex: https://s3-bucketname-serverless-graphql.s3-website-us-east-1.amazonaws.com
Run the deployment command
app-client/<client-name>/
rn deploy-s3
Your deployment url will be printed on the console
Your deployment url will be : https://s3.amazonaws.com/[bucket-name]/index.html
Netlify
First you will need to create a new account. Please see https://www.netlify.com/docs/cli/ for details.
Remove homepage property in app-client/<client-name>/package.json. This property is not required while deploying to netlify but is required for aws s3 deployment.
The first time you use the cli tool, you?ll be asked to authenticate through the browser. After you authenticate netlify will store an access token in a global ~/.netlify/config
Run deployment command
app-client/<client-name>/
rn deploy-netlify
Your deployment url will be printed on the console
Mutation {
# Create a tweet for a user
# consumer keys and tokens are not required for dynamo integration
createTweet(
tweet: String!,
consumer_key: String,
consumer_secret: String,
access_token_key: String,
access_token_secret: String,
created_at: String!
): Tweet!
# Delete User Tweet
deleteTweet(
tweet_id: String!,
consumer_key: String,
consumer_secret: String,
access_token_key: String,
access_token_secret: String
): Tweet!
# Retweet existing Tweet
reTweet(
tweet_id: String!,
consumer_key: String,
consumer_secret: String,
access_token_key: String,
access_token_secret: String
): Tweet!
# Update existing Tweet
updateTweet(tweet_id: String!, tweet: String!): Tweet!
# Create user info is available in dynamo integration
updateUserInfo(
location: String!,
description: String!,
name: String!,
followers_count: Int!,
friends_count: Int!,
favourites_count: Int!,
followers: [String!]!
): User!
Query {
meInfo(consumer_key: String, consumer_secret: String): User!
getUserInfo(handle: String!, consumer_key: String, consumer_secret: String): User!
# search functionality is available in elasticsearch integration
searchAllTweetsByKeyword(keyword: String!): TweetConnection
Subscription {
addTweet: Tweet
@aws_subscribe(mutations: ["createTweet"])
Tweet {
tweet_id: String!
tweet: String!
retweeted: Boolean
retweet_count: Int
favorited: Boolean
created_at: String!
TweetConnection {
items: [Tweet!]!
nextToken: String
User {
name: String!
handle: String!
location: String!
description: String!
followers_count: Int!
friends_count: Int!
favourites_count: Int!
followers: [String!]!
topTweet: Tweet
tweets(limit: Int!, nextToken: String): TweetConnection
# search functionality is available in elasticsearch integration
searchTweetsByKeyword(keyword: String!): TweetConnection
ma {
query: Query
mutation: Mutation
subscription: Subscription
/app-client/ # React JS Client Integrations
??? /appsync-client # Appsync Client Itegrations
? ??? /public/ # front End Utils
? ? ??? /index.html # main html file to render react app
? ? ??? /... # front end metadata
? ??? /src/ # react app code logic
? ? ??? /componenets/ # react componenets
? ? ??? /App.js # react application logic
? ? ??? /index.js # react dom render
? ? ??? /aws-exports.js # AWS Authentication
? ? ??? /... # etc.
? ??? /package.json # react app dependencies
? ??? /serverless.yml # Serverless yaml for AWS deployment
??? /apollo-client # Apollo Client Itegrations
? ??? /public/ # front End Utils
? ? ??? /index.html # main html file to render react app
? ? ??? /... # front end metadata
? ??? /src/ # react app code logic
? ? ??? /componenets/ # react componenets
? ? ??? /App.js # react application logic
? ? ??? /index.js # react dom render
? ? ??? /... # etc.
? ??? /package.json # react app dependencies
? ??? /serverless.yml # Serverless yaml for AWS deployment
/app-backend/ # Server Backend Integrations
??? /appsync/ # AWS Appsync Integrations
? ??? /dynamodb/* # AWS Appsync Dynamodb
? ??? /elasticsearch/* # AWS Appsync Elasticsearch
? ??? /lambda/ # AWS Appsync Lambda
??? /dynamodb # Integration with DynamodDB Backend
? ??? /seed-data/ # seed test data
? ? ??? /create_seed_data.js # Create Seed data to be inserted in dynamodb local and remote
? ? ??? /insert_seed_data_prod.js # Insert seed data in aws dynamodb (serverless)
? ? ??? /sample-query.txt # Test Query on DynamoDB Local Client http://localhost:8000
? ??? /handler.js # AWS Lambda - Apollo Lambda Server
? ??? /package.js # server side dependencies
? ??? /resolvers.js # graphql resolvers
? ??? /schema.js # graphql schema
? ??? /serverless.yml # Serverless yaml for AWS deployment
? ??? /webpack.config.js # Webpack server side code with ES6
??? /rest-api # Integration with REST API Backend
? ??? /handler.js # AWS Lambda - Apollo Lambda Server
? ??? /package.js # server side dependencies
? ??? /resolvers.js # graphql resolvers
? ??? /schema.js # graphql schema
? ??? /serverless.yml # Serverless yaml for AWS deployment
? ??? /webpack.config.js # Webpack server side code with ES6
??? /RDS # Integrations for PostGres, MySQL and Aurora Backend
? ??? /seed-data/ # seed test data
? ? ??? /create_seed_data.js # Create Seed data to be inserted in dynamodb local and remote
? ? ??? /seed_local.js # Insert seed data in aws dynamodb (serverless)
? ? ??? /seed_prod.js # Test Query on DynamoDB Local Client http://localhost:8000
? ??? /migrations/ # Create DDL statements
? ??? /kenxfile # Database Configurations
? ??? /handler.js # AWS Lambda - Apollo Lambda Server
? ??? /package.js # server side dependencies
? ??? /resolvers.js # graphql resolvers
? ??? /schema.js # graphql schema
? ??? /serverless.yml # Serverless yaml for AWS deployment
? ??? /webpack.config.js # Webpack server side code with ES6
/config/ # Configuration files
??? /security.env.local # local config
??? /security.env.prod # production config
To use the GraphQL Playground, open /playground of your Serverless service. With serverless offline it is http://localhost:4000/playground. Why GraphQL Playground and not GraphiQL? Refer FAQ
To use the GraphiQL, open /graphiql of your Serverless service. With serverless offline it is http://localhost:4000/graphiql.
As the Serverless GraphQL Apollo community grows, we'd like to keep track of who is using the platform. Please send a PR with your company name and @githubhandle if you may.
Currently officially using Serverless GraphQL Apollo :
