api-gateway

API Gateway

This repository contains the GraphQL API Gateway for the BetterGR system. The API gateway acts as an interface between the frontend application and the various microservices.

Setup

Prerequisites

• Go (latest stable version recommended)
• Make (for running the Makefile commands)

Environment Configuration

Make sure to have a .env file in the root directory. Here is an example:

# API Gateway Configuration
API_GATEWAY_PORT=1234

# Authentication Settings
CLIENT_SECRET=**********
KEYCLOAK_URL=http://auth.betterGR.org
REDIRECT_URI=http://localhost:3000/callback

# Microservice Addresses
GRADES_PORT=localhost:50051
STUDENTS_PORT=localhost:50052
HOMEWORK_PORT=localhost:50053
COURSES_PORT=localhost:50054
STAFF_PORT=localhost:50055

Running the API Gateway

To run the API Gateway server:

go run server.go

Alternatively, you can use the provided PowerShell script:

./run-api-gateway.ps1

Development

Modifying the GraphQL Schema

When changing the schema file (schema.graphqls), make sure to regenerate the Go code by running:

gqlgen generate

This will update all generated files based on your schema changes.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.