batnoter api

Módulo API de Batnoter

Este es el servicio API de la aplicación Batnoter construida con Golang.

Expone los puntos finales REST para acceder y administrar notas de Markdown desde el repositorio Git del usuario. Actualmente solo admite el repositorio de GitHub para almacenar y administrar notas.

Configuración de desarrollo local

Requisitos previos

• Go Versión 1.18 o superior
• Escritorio de Docker

Iniciar contenedor de base de datos Postgres

A continuación, los comandos usan Docker para iniciar el contenedor de la base de datos.

make network
make postgres
make createdb

Crear archivo de configuración a partir de la plantilla

config.yaml es el archivo de plantilla de configuración que contiene valores de configuración predeterminados.

cp config.yaml .config.yaml

La aplicación utiliza el archivo .config.yaml para obtener los valores de configuración. Actualice los valores de marcador de posición de este archivo de configuración a los reales.

Iniciar el servidor

Asegúrese de que el archivo .config.yaml esté configurado correctamente y el contenedor de la base de datos esté en funcionamiento. Luego ejecute los comandos a continuación para configurar el esquema de DB e iniciar el servidor web.

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

Esto iniciará el servidor en el puerto especificado en el archivo .config.yaml . Ahora puede acceder a los puntos finales de la API.

Ejecutar pruebas

go test -v -cover ./...

Esto ejecutará todas las pruebas y también imprime el porcentaje de cobertura del código.

Pautas de contribución

Cada contribución hace la diferencia

Lea las pautas de contribución antes de contribuir.

Agradecimiento especial