# README
go-go-api
Uma aplicação Go para gerenciar tenants, implementada com GORM para interação com banco de dados PostgreSQL e estruturada com práticas recomendadas para facilitar a manutenção e a escalabilidade.
Começando
Estas instruções fornecerão uma cópia do projeto em execução na sua máquina local para fins de desenvolvimento e teste.
Pré-requisitos
O que você precisa para instalar o software e como instalá-los:
- Go (versão 1.16 ou superior)
- PostgreSQL
Instalação
Um passo a passo que informa o que você deve executar para ter um ambiente de desenvolvimento rodando:
- Clone o repositório:
git clone https://github.com/jeancarlosdanese/go-go-api
- Navegue até o diretório do projeto:
cd go-go-api
- Instale as dependências do Go (assegure-se de que está no diretório do projeto):
go mod tidy
-
Crie um arquivo .env basgoo no exemplo .env.example fornecido e ajuste as configurações do banco de dados conforme necessário.
-
Execute as migrações do banco de dados:
migrate -path ./migrations -database "postgresql://postgres:postgres@localhost:5432/go_go_api?sslmode=disable" up
- Execute a aplicação:
go run ./cmd/go_api
Rodando os testes
go test ./...
Construído com
- Go - A linguagem de programação usada.
- GORM - ORM usado.
- golang-migrate/migrate - Ferramenta de migração de banco de dados.
- Swaggo, uma ferramenta que analisa os comentários do código Go e gera uma documentação de API Swagger.
Licenças das Dependências
Abaixo está a distribuição das licenças das dependências do projeto:
| Licença | Porcentagem |
|---|---|
| Apache-2.0 | 10,53% |
| BSD-3-Clause | 21,05% |
| MIT | 68,42% |
| Total Geral | 100,00% |