development.md

Development Guide

This guide covers everything you need to know to run the core-service locally.

Prerequisites

• Go
• Docker & Docker Compose
• Make

Useful Links

• Gin-gonic Documentation
• golang-migrate
• Swaggo

Setup Steps

1. Environment Variables: Copy the example environment file and configure it.

   cp .env.example .env

2. Start Development Environment: Using the provided Makefile, you can spin up the application, database, and bucket storage locally.

   make dev

   Note: This starts the containers detached and provides an interactive shell for manual executions if needed.

3. Running Locally (without Docker):

   go run cmd/main.go

Database Migrations

Migrations are handled via golang-migrate.

• Automatic execution is handled on server start if DB_SHOULD_MIGRATE=true.
• To generate a new migration:

  make migration service=<service_name> name=<migration_name>

API Documentation (Swagger)

Swagger docs are automatically generated.

• Generate docs locally: make swagger or swag init -g cmd/main.go -o ./swagger
• Access Swagger UI: http://localhost:8000/swagger/index.html

Useful Scripts

• scripts/seed_items.sh: Script to seed items with sprites and categories.
• scripts/reset_items_data.sh: Erase all items/categories from the DB.