rpkm67-checkin

Stack

• golang
• gRPC
• postgresql
• redis
• minio

Getting Started

Prerequisites

• 💻
• golang 1.22 or later
• docker
• makefile
• Go Air

Installation

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

Running only this service

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

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

1. Copy docker-compose.qa.template.yml and paste it in the same directory as docker-compose.qa.yml. Fill in the appropriate values.
2. 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).
3. Run make pull-latest-mac or make pull-latest-windows to pull the latest images of other services.
4. Run make docker-qa.
5. Run make server or air for hot-reload.

Unit Testing

1. 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