rpkm67-checkin

Stack

golang
gRPC
postgresql
redis
minio

Getting Started

Prerequisites

💻
golang 1.22 or later
docker
makefile
Go Air

Installation

Clone this repo
Run go mod download to download all the dependencies.

Running only this service

Copy .env.template and paste it in the same directory as .env. Fill in the appropriate values.
Run make docker.
Run make server or air for hot-reload.

Running all RPKM67 services (all other services are run as containers)

Copy docker-compose.qa.template.yml and paste it in the same directory as docker-compose.qa.yml. Fill in the appropriate values.
In microservices/auth folder, copy staff.template.json and paste it in the same directory as staff.json. It is the staffs' student id list (given staff roles instead of user).
Run make pull-latest-mac or make pull-latest-windows to pull the latest images of other services.
Run make docker-qa.
Run make server or air for hot-reload.

Unit Testing

Run make test

API

When run locally, the gateway url will be available at localhost:3001.

Swagger UI: localhost:3001/api/v1/docs/index.html#/
Grafana: localhost:3006 (username: admin, password: 1234)
Prometheus: localhost:9090
Gateway's metrics endpoint: localhost:3001/metrics

Other microservices/repositories of RPKM67

gateway: Routing and request handling
auth: Authentication and user service
backend: Group, Baan selection and Stamp, Pin business logic
checkin: Checkin for events service
store: Object storage service for user profile pictures
model: SQL table schema and models
proto: Protobuf files generator
go-proto: Generated protobuf files for golang
frontend: Frontend web application