https://github.com/city-of-helsinki/youth-federation-gateway

Apollo federation gateway for youth-membership service
https://github.com/city-of-helsinki/youth-federation-gateway

Last synced: about 1 month ago
JSON representation

Apollo federation gateway for youth-membership service

• Host: GitHub
• URL: https://github.com/city-of-helsinki/youth-federation-gateway
• Owner: City-of-Helsinki
• License: mit
• Created: 2020-08-28T06:44:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-16T01:59:33.000Z (about 1 year ago)
• Last Synced: 2024-04-08T16:43:30.979Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 214 KB
• Stars: 0
• Watchers: 22
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# youth-federation-gateway

:link: Apollo federation gateway for youth-membership service :boy: :girl: :id:

## Overview

[Apollo-federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/) is

a gateway proxy that enables combining multiple sources of data into a single GraphQL API.

with it, you can split your data between different APIs, as long as they have a common

unique field that can be used as key to identify them by.

This specific gateway combines two projects:

1. [open-city-profile](https://github.com/City-of-Helsinki/open-city-profile)

2. [youth-membership](https://github.com/City-of-Helsinki/youth-membership)

## Set up w/ Docker

0. You need to have the two projects mentioned above running somewhere (locally,

    staging or production).

1. Create `docker-compose.env.yaml` in the root of the project, for example using

    the template file:

    * `cp docker-compose.env.yaml.example docker-compose.env.yaml`

2. Put proper links to GraphQL APIs for open-city-profile and youth-membership.

    * current placeholder in the template will work if you use default docker-compose

      setups for each project

    * you can use the test instances managed by the City of Helsinki:

        - https://profiili-api.test.kuva.hel.ninja/graphql/ for profile

        - https://jassari.api.test.hel.ninja/graphql/ for youth membership

3. Adjust other variables according to your needs.

4. Run `docker-compose up`

The project is now running at [localhost:3000](http://localhost:3000) (or at the

PORT you specified in the `docker-compose.env.yaml`)

## Environments

Test environment: https://jassari-federation.test.hel.ninja/

Voyager graph of all Quieries: https://jassari-federation.test.hel.ninja/voyager