Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 2.73 KB

README.md

File metadata and controls

38 lines (31 loc) · 2.73 KB

Apollo Server JavaScript Subgraph Template

Deploy on Railway

This template can be used to quickly create an Apollo Federation subgraph with the @apollo/subgraph and @apollo/server packages. You can use it from Rover with rover template use --template subgraph-javascript-apollo-server.

What's Included

  • A basic, Apollo Federation subgraph with simple examples for queries, entities, and mutations. You can run this subgraph with npm start.
  • nodemon is setup for npm run dev for a hot-reloading development environment.
  • Example tests in the src/__tests__ directory. You can run these tests with npm run test.
  • GitHub Actions workflows which will:
    • Run npm run test on every push.
    • Check the schema against Apollo Studio on every push.
    • Publish the subgraph to Apollo Studio on every push to the main branch.

Next Steps

  • Setup project with npm install.
  • Start the server with npm start to start a local version of Apollo Explorer.
  • Download Rover and start it using the command printed out after npm start in the previous step (which should start with something like rover dev).
  • Replace "name" in package.json with the name of your subgraph.
  • Start filling in your own schema in schema.graphql.
  • Start filling in your own types and resolvers in src/resolvers.
  • Set these secrets in GitHub Actions to enable all checks:
    • APOLLO_KEY: An Apollo Studio API key for the supergraph to enable schema checks and publishing of the subgraph. Check the Apollo documentation for how to obtain this API key.
    • APOLLO_GRAPH_REF: A string with the following format: graph_id@variant_name. You can find your graph's ID in that graph's Settings page in Studio.
    • PRODUCTION_URL: The URL of the deployed subgraph.
  • Remove the if: false lines from .github/workflows/checks.yaml and .github/workflows/deploy.yaml to enable schema checks and publishing.
  • Write your custom deploy logic in .github/workflows/deploy.yaml.
  • Send the Router-Authorization header from your Cloud router and set the ROUTER_SECRET environment variable wherever you deploy this to.