batnoter api

Batnoter API модуль

Это сервис API приложения Batnoter, построенный с Golang.

Он обнаруживает конечные точки REST для доступа и управления заметками Markdown из репозитория GIT пользователя. В настоящее время он поддерживает только репозиторий GitHub для хранения и управления заметками.

Настройка локальной разработки

Предварительные условия

• Перейти версию 1.18 или выше
• Docker Desktop

Start Postgres Batabase Container

Ниже команды используют Docker, чтобы запустить контейнер с базой данных.

make network
make postgres
make createdb

Создать файл конфигурации из шаблона

config.yaml - это файл шаблона конфигурации, содержащий значения конфигурации по умолчанию.

cp config.yaml .config.yaml

Приложение использует файл .config.yaml для получения значений конфигурации. Пожалуйста, обновите заполнительные значения из этого файла конфигурации в реальные.

Запустить сервер

Убедитесь, что файл .config.yaml настроен правильно, а контейнер базы данных работает. Затем запустите приведенные ниже команды, чтобы настроить схему DB и запустить веб -сервер.

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

Это запустит сервер на порте, указанный в файле .config.yaml . Теперь вы можете получить доступ к конечным точкам API.

Запустить тесты

go test -v -cover ./...

Это выполнит все тесты, а также печатает процент покрытия кода.

Руководящие принципы вклада

Каждый вклад имеет значение

Прочитайте руководящие принципы вклада, прежде чем внести свой вклад.

Особая благодарность