batnoter api

Módulo API de Batnoter

Este é o serviço API do aplicativo Batnoter construído com Golang.

Ele expõe pontos de extremidade de repouso para acessar e gerenciar notas de marcação do repositório Git do usuário. Atualmente, ele suporta apenas o repositório do GitHub para armazenar e gerenciar notas.

Configuração de desenvolvimento local

Pré -requisitos

• GO Versão 1.18 ou acima
• Docker Desktop

Inicie o contêiner de banco de dados Postgres

Os comandos abaixo usam o Docker para iniciar o contêiner do banco de dados.

make network
make postgres
make createdb

Crie arquivo de configuração do modelo

O config.yaml é o arquivo de modelo de configuração que contém valores de configuração padrão.

cp config.yaml .config.yaml

Usos do aplicativo .config.yaml arquivo para obter os valores de configuração. Atualize os valores de espaço reservado deste arquivo de configuração para os reais.

Inicie o servidor

Verifique se o arquivo .config.yaml está configurado corretamente e o contêiner de banco de dados está em execução. Em seguida, execute os comandos abaixo para configurar o esquema do banco de dados e iniciar o servidor da web.

go run main.go migrateup
go run main.go serve

Isso iniciará o servidor na porta especificado no arquivo .config.yaml . Agora você pode acessar os pontos de extremidade da API.

Executar testes

go test -v -cover ./...

Isso executará todos os testes e também imprime a porcentagem de cobertura do código.

Diretrizes de contribuição

Cada contribuição faz a diferença

Leia as diretrizes de contribuição antes de contribuir.

Obrigado especial