README-PTBR.md

Featws API

Como executar

Para executar este projeto, você precisa ter certos pré-requisitos configurados em sua máquina. Esses pré-requisitos incluem:

• Golang
• Swaggo
• Docker

Para executar o projeto, siga estes passos:

• Abra o terminal no diretório do projeto e execute o comando go mod tidy para garantir que todas as dependências necessárias estejam instaladas.

• Em seguida, execute o comando swag init para inicializar o Swagger e gerar a documentação da API necessária.

• Abra o Docker da sua máquina, ou algum semelhante, para garantir que ele está funcionado. Logo, abra o terminal no repositório do projeto e rode docker compose up.

• Após os containers serem iniciados e estarem rodando, execute o comando make run no terminal do projeto para iniciar o projeto.

O projeto será executado em localhost:9007. Para acessar a documentação do Swagger, clique aqui.

Seguindo estes passos, o projeto estará em execução e você poderá acessar a documentação da API através do Swagger.

GoDoc

Para acessar a documentação do GoDoc, primeiro instale o GoDoc na sua máquina. Abra um terminal e digite:

go get golang.org/x/tools/cmd/godoc

Em seguida rode no terminal do repositório o comando a seguir:

godoc -http=:6060

O GoDoc será executado em localhost:6060. Para acessar a documentação do GoDoc, basta clicar aqui.

MacOS config

O MySQL usado no arquivo Docker compose não é compatível aos chips da Apple (M1 e M2). Para que funcione faça as seguintes alterações:

Arquivo .env

Crie a variável FEATWS_API_MYSQL_URI e adicione o caminho como a seguir:

FEATWS_API_MYSQL_URI=api:api@tcp(localhost:3307)/api

Docker Compose

No docker compose será necessário que seja alterado o MySQL para o MariaDB. Apenas é necessário alterar o db do docker-compose.

  db:
    image: mariadb
    restart: always
    ports:
      - 3307:3306
    volumes:
      - ./data/mysql:/var/lib/mysql:rw
    user: mysql
    environment:
      MARIADB_ROOT_PASSWORD: "root"
      MARIADB_DATABASE: "api"
      MARIADB_USER: "api"
      MARIADB_PASSWORD: "api"
      TELEMETRY_HTTPCLIENT_TLS: "false"
      TELEMETRY_EXPORTER_JAEGER_AGENT_HOST: "localhost"
      TELEMETRY_ENVIRONMENT: local