# README

game-library

Introduction

game-library is a web application for exploring and rating games written in Go and TypeScript. It consists of three services:

current service is responsible for fetching, storing games data and providing it to UI,
auth service is responsible for user authentication and authorization,
ui service is responsible for UI representation.

Installation

Prerequisites: go, Docker, Make. To set up the service, follow these steps:

Clone the repository:

git clone https://github.com/OutOfStack/game-library.git
cd game-library

Set up the database:

make dockerrunpg # runs postgres in docker container
make createdb # creates db
make migrate # applies migrations
# optionally
make seed # applies test data

Install and run dependencies:

make dockerrunglog # [Optional] runs graylog in docker container
make dockerrunredis # [Optional] runs redis in docker container
make dockerrunzipkin # [Optional] runs zipkin

[Optional] Set up fetching games data:
- Get credentials from IGDB API to run background task that fetches games
- Get credentials from Uploadcare API for uploading game images
[Optional] Install auth service for using handlers that require authentication
Build and run the service:
```
make build
make run
```

Optional steps are not required for minimal install but required for full functionality.

Refer to the List of Make commands for a complete list of commands.

Usage

After installation, you can use the following Make commands to develop the service:

make test: Runs tests.
make generate: Generates documentation for Swagger UI.
make lint: Runs golangci-lint for code analysis.

Refer to the List of Make commands for a complete list of commands.

Features

Data storage with PostgreSQL.
Caching with Redis.
Tracing with Zipkin.
Log management with Graylog.
Background fetching of game data from IGDB.
Reuploading game images to Uploadcare CDN.
Code analysis with golangci-lint.
CI/CD with GitHub Actions and deploy to Kubernetes (microk8s) cluster.

Configuration

The service can be configured using app.env or environment variables, described in settings.go
CI/CD configs are in ./.github/workflows/
k8s deployment configs are in ./.k8s/

Documentation

API documentation is available at Swagger UI. For regenerating documentation after swagger description change run make generate.

Examples

Endpoint that returns 3 games ordered by release date:

curl -X GET "http://localhost:8000/api/games?pageSize=3&page=1&orderBy=releaseDate"

To see other examples of API endpoints, refer to the documentation.

List of Make commands:

build           builds app
run             runs app
test            runs tests for the whole project
generate        generates documentation for swagger UI and mocks
lint            runs golangci-lint

dockerrunpg     runs postgres server in docker container
createdb        creates database on postgres server started by 'dockerrunpg'
dropdb          drops database on postgres server created by 'dockerrunpg'
migrate         applies all migrations to database
rollback        rollbacks last migration on database
seed            seeds test data to database

dockerbuildapi  builds app docker image
dockerrunapi    runs app in docker container
dockerrunzipkin runs zipkin in docker container
dockerrunglog   runs graylog in docker container
dockerrunredis  runs redis in docker container
dockerbuildmng  builds manage app docker image
dockerrunmng-m  applies migrations to database using docker manage image
dockerrunmng-r  rollbacks one last migration using docker manage image
dockerrunmng-s  seeds test data to database using docker manage image