Skip to content
This repository has been archived by the owner on Dec 2, 2024. It is now read-only.

Commit

Permalink
docs(issue-34): updates docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jefersonhuan committed Jul 30, 2024
1 parent 2f3c65b commit 0e74c0d
Show file tree
Hide file tree
Showing 2 changed files with 266 additions and 1,155 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,29 @@ DB_NAME=postgres
DB_PORT=5432
```

## Executing with Docker Compose
## Executing with Docker (Compose)

```shell
docker-compose build
docker compose build

docker-compose up -d
docker compose up -d

curl --request GET --url http://localhost:8080/health

## Expected response
= Status Code 200
```

> If you're having trouble deploying the application with `docker-compose` (and not `docker compose`), use docker version 27.0.0 or higher.
## Accessing Swagger UI

Go to http://localhost:8080/swagger/index.html#/ after the application is running.

## Guide

Follow the guide (in portuguese) for a step-by-step guide to the project [here](https://github.com/pangolin-do-golang/tech-challenge/wiki/Guia-de-uso-da-API).

## Stack

- [Go](https://go.dev/)
Expand Down
Loading

0 comments on commit 0e74c0d

Please sign in to comment.