{"id":19042500,"url":"https://github.com/serverless/serverless-graphql-relay","last_synced_at":"2025-07-03T16:32:17.237Z","repository":{"id":65982493,"uuid":"79071844","full_name":"serverless/serverless-graphql-relay","owner":"serverless","description":"Serverless GraphQL Boilerplate using Relay – Ready to be deployed to production within minutes …","archived":false,"fork":false,"pushed_at":"2017-09-25T19:41:18.000Z","size":8178,"stargazers_count":32,"open_issues_count":2,"forks_count":6,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-04-23T22:32:00.750Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-16T01:30:09.000Z","updated_at":"2020-02-24T11:09:07.000Z","dependencies_parsed_at":"2023-02-19T18:31:16.892Z","dependency_job_id":null,"html_url":"https://github.com/serverless/serverless-graphql-relay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/serverless/serverless-graphql-relay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-graphql-relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-graphql-relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-graphql-relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-graphql-relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverless","download_url":"https://codeload.github.com/serverless/serverless-graphql-relay/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-graphql-relay/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263360808,"owners_count":23454787,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T22:38:03.201Z","updated_at":"2025-07-03T16:32:17.205Z","avatar_url":"https://github.com/serverless.png","language":"JavaScript","readme":"# Serverless GraphQL\n\nThis 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.\n\nThis example uses the following technologies:\n\n- Serverless\n- GraphQL-js\n- Relay\n- React\n- CSSModules\n- Webpack\n- Jest\n\n## Install \u0026 Run\n\nYou need to have node 6 or higher installed.\n\n```\nnpm install -g serverless\nnpm install\n```\n\nUse mocked data (keep in mind due hard-coded data the interface might behave not as expected)\n```\nnpm run update-schema\nnpm start\n# visit http://localhost:3000 in your browser\n```\n\nUse live data from the development environment. You need to make sure you have access to your deployed lambda functions. This works only after you deployed it to production.\n\n```\nnpm run update-schema\nnpm run start:remote\n# visit http://localhost:3000 in your browser\n```\n\n## Setup for Production\n\nAWS has global unique bucket names. You need to replace `\u003cyour-s3-bucket-name\u003e` in package.json as well as in the serverless.yml with your own custom name.\n\nSince the URL of the API is unknown until you create a stack, you need to deploy once without expecting the application to work using `npm run deploy`. After the initial deploy you can see the API url which you need to provide to the URL entry in `security.env.prod`.\n\n![deploy feedback](https://cloud.githubusercontent.com/assets/223045/19171420/6e271150-8bd1-11e6-9b49-e9fa88cac379.png)\n\nAfter these steps you are good to go and with your next `npm run deploy` your infrastructure should up and running. Visit `http://\u003cyour-s3-bucket-name\u003e.s3-website-us-east-1.amazonaws.com` in your browser.\n\n## Developing\n\nIf you make changes to the GraphQL schema stop the server, regenerate it and restart the server:\n\n```\nnpm run update-schema\nnpm start\n```\n\n## Testing\n\nWe use Jest as a test runner. To run all tests use\n\n```\nnpm run test\n```\n\nTo update component snapshots after updating a component use\n\n```\nnpm run test:update\n```\n\n## Security\n\nAt Serverless we keep our keys encrypted in the repository. We recommend you to do the same. In our case deploying to a staging and production system is done via a continuous integration system which has the secret to decrypt the necessary file with the environment variables. For demo purposes this repository has an unencrypted file for environment variables at `foundation/environment/security.env.local` and `foundation/environment/security.env.prod`.\n\n## Multiple package.json\n\nIn order to keep the total amount of code uploaded to AWS Lambda small the `api` directory containing the Serverless service has it's own `package.json`. This speeds up uploading and also should reduce the cold start time of Lambda functions. You don't have to run `npm install` manually at any point. It will only happen during deploy, but you need make sure every library you are consuming in your GraphQL endpoint is added as a dependency there.\n\n### `package.json`\n\n- dependencies: dependencies used by the front-end\n- devDependencies: dependencies used to package the front-end application \u0026 running the local environment\n\n### `api/package.json`\n\n- dependencies: dependencies used on AWS Lambda\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless%2Fserverless-graphql-relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverless%2Fserverless-graphql-relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless%2Fserverless-graphql-relay/lists"}