Skip to content

Commit 14d6d4d

Browse files
Translate README to English and pin images v0.2.0
Translate Quick Start and local development instructions in README from Portuguese to English and clarify Docker usage text. Simplified/removed the previous update/pin-version examples from the README. Update docker-compose.prod.yml to mark the file for v0.2.0 and pin the gateway and web service images to ghcr.io/...:v0.2.0 (replacing :latest), preparing the repository for the v0.2.0 release.
1 parent be456a6 commit 14d6d4d

2 files changed

Lines changed: 17 additions & 32 deletions

File tree

README.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,72 +31,58 @@ This repository contains an initial skeleton with a working bootstrap pipeline:
3131

3232
## Quick Start
3333

34-
### Opção 1 — Docker (recomendado, sem precisar do código fonte)
34+
### Option 1 — Docker (recommended, no source code required)
3535

36-
**Pré-requisitos:** Docker Desktop ou Docker Engine com Compose v2.
36+
**Prerequisites:** Docker Desktop or Docker Engine with Compose v2.
3737

3838
```bash
39-
# 1. Baixar o compose de produção
39+
# 1. Download the production compose file
4040
curl -O https://raw.githubusercontent.com/vagnercazarotto/verifhir-gateway/main/docker-compose.prod.yml
4141

42-
# 2. Subir (as imagens são puxadas automaticamente do GHCR)
42+
# 2. Start (images are pulled automatically from GHCR)
4343
docker compose -f docker-compose.prod.yml up -d
4444
```
4545

46-
Abrir no browser: **http://localhost:3000**
46+
Open in your browser: **http://localhost:3000**
4747

48-
| Porta | Serviço |
48+
| Port | Service |
4949
|---|---|
5050
| 3000 | Web UI (React) |
5151
| 8080 | REST API |
5252
| 2575 | MLLP listener |
5353

54-
**Atualizar para a versão mais recente:**
55-
56-
```bash
57-
docker compose -f docker-compose.prod.yml pull
58-
docker compose -f docker-compose.prod.yml up -d
59-
```
60-
61-
**Fixar versão específica** (recomendado em produção) — editar o arquivo e substituir `latest` por ex. `v0.2.0`:
62-
63-
```yaml
64-
image: ghcr.io/vagnercazarotto/verifhir-gateway:v0.2.0
65-
image: ghcr.io/vagnercazarotto/verifhir-web:v0.2.0
66-
```
67-
68-
**Parar e remover:**
54+
**Stop and remove:**
6955

7056
```bash
7157
docker compose -f docker-compose.prod.yml down
7258
```
7359

7460
---
7561

76-
### Opção 2 — Desenvolvimento local (com código fonte)
62+
### Option 2 — Local development (with source code)
7763

78-
**Pré-requisitos:** Go 1.25+, Node 22+, Docker Desktop.
64+
**Prerequisites:** Go 1.25+, Node 22+, Docker Desktop.
7965

8066
```bash
8167
git clone https://github.com/vagnercazarotto/verifhir-gateway.git
8268
cd verifhir-gateway
8369

84-
# Subir tudo com build local
70+
# Start everything with a local build
8571
docker compose up --build -d
8672
```
8773

88-
Ou rodar cada serviço separadamente:
74+
Or run each service separately:
8975

9076
```bash
91-
# Terminal 1 — Gateway Go
77+
# Terminal 1 — Go Gateway
9278
mkdir -p .local
9379
go run ./cmd/gateway
9480

95-
# Terminal 2 — Web UI (dev server com hot-reload)
81+
# Terminal 2 — Web UI (dev server with hot-reload)
9682
cd web && npm install && npm run dev
9783
```
9884

99-
Web UI disponível em **http://localhost:5173** (proxy automático para a API em :8080).
85+
Web UI available at **http://localhost:5173** (automatic proxy to the API at :8080).
10086

10187
### Prerequisites (legacy scripts)
10288

docker-compose.prod.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# VeriFHIR Gateway — Production deployment
1+
# VeriFHIR Gateway — Production deployment (v0.2.0)
22
#
33
# Usage:
44
# curl -O https://raw.githubusercontent.com/vagnercazarotto/verifhir-gateway/main/docker-compose.prod.yml
55
# docker compose -f docker-compose.prod.yml up -d
66
#
77
# Images are pulled from GitHub Container Registry (no build required).
8-
# Pin a specific version by replacing "latest" with e.g. "v0.2.0".
98

109
services:
1110
gateway:
12-
image: ghcr.io/vagnercazarotto/verifhir-gateway:latest
11+
image: ghcr.io/vagnercazarotto/verifhir-gateway:v0.2.0
1312
pull_policy: always
1413
ports:
1514
- "8080:8080" # REST API
@@ -30,7 +29,7 @@ services:
3029
retries: 3
3130

3231
web:
33-
image: ghcr.io/vagnercazarotto/verifhir-web:latest
32+
image: ghcr.io/vagnercazarotto/verifhir-web:v0.2.0
3433
pull_policy: always
3534
ports:
3635
- "3000:80"

0 commit comments

Comments
 (0)