Skip to content

Latest commit

 

History

History
118 lines (91 loc) · 3.76 KB

README.md

File metadata and controls

118 lines (91 loc) · 3.76 KB
Raw

Voyage I: Federation from Day One

Welcome to FlyBy, the companion app of Odyssey Voyage I! You can find the course lessons and instructions in Odyssey, Apollo's learning platform.

You can preview the completed demo app here.

How to use this repo

The course will walk you step by step through how to implement the features you see in the demo app. This codebase is the starting point of your journey!

Backend

You will work in three main folders:

  • router
  • subgraph-locations
  • subgraph-reviews

The course will help you set up and run each of these servers.

Frontend

The repo also includes a client folder, which includes the frontend for the FlyBy app. You won't need to edit the code in this directory.

To run the client:

  1. Open a new terminal window, and navigate to the client folder.
  2. Run npm install & npm start. This will install all packages in the client and start the application in localhost:3000.

final folder

The repo also includes a final folder, to show what your code should look like once you've finished the course. You can use it to check your work if you get stuck.

Publish the subgraph schemas to Apollo Studio

  1. Run rover config auth to set the APOLLO_KEY value
  2. Navigate to final/subgraph-locations.
  3. Run rover subgraph publish <APOLLO_GRAPH_REF> --name locations --schema locations.graphql --routing-url http://localhost:4001
  4. Navigate to final/subgraph-reviews.
  5. Run rover subgraph publish <APOLLO_GRAPH_REF> --name reviews --schema locations.reviews --routing-url http://localhost:4001

To run the servers in the final folder:

  1. Open a new terminal window, and navigate to final/router.
  2. Run APOLLO_KEY=<APOLLO_KEY> APOLLO_GRAPH_REF=<APOLLO_GRAPH_REF> ./router --config config.yaml. This will start the router at http://127.0.0.1:4000/ and allow access from localhost:3000 for the client.
  3. Open another new terminal window, and navigate to final/subgraph-locations.
  4. Run npm install && npm start again. This will install all packages for the locations subgraph, then start the subgraph at http://localhost:4001.
  5. Open a third new terminal window, and navigate to final/subgraph-reviews.
  6. Run npm install && npm start again. This will install all packages for the reviews subgraph, then start the subgraph at http://localhost:4002.
  7. In a web browser, open Apollo Studio Sandbox for http://localhost:4000. You should be able to run queries against your gateway server. Some test queries are included in the following section.

Queries

  1. Get all locations for the homepage.

    query getAllLocations {
  locations {
    id
    name
    photo
    description
    overallRating
  }
}

  2. Get the latest reviews for the homepage.

    query LatestReviews {
  latestReviews {
    comment
    rating
    location {
      name
      description
    }
  }
}

  3. Get details for a specific location.

    query getLocationDetails {
  location(id: "loc-1") {
    id
    name
    description
    photo
    overallRating
    reviews {
      comment
      rating
    }
  }
}

  4. Submit a review for a location.

    mutation submitReview {
  submitReview(review: { comment: "Wow, such a great planet!", rating: 5, locationId: "1" }) {
    code
    success
    message
    review {
      id
      comment
      rating
    }
  }
}

Getting Help

For any issues or problems concerning the course content, please refer to the Odyssey topic in our community forums.