batnoter api

Batnoter -API -Modul

Dies ist der API -Service der mit Golang erstellten Batnoter -Anwendung.

Es enthält REST -Endpunkte, um auf Markdown -Notizen aus dem Git -Repository des Benutzers zuzugreifen und zu verwalten. Derzeit unterstützt es nur Github Repository für das Speichern und Verwalten von Notizen.

Lokale Entwicklungssetup

Voraussetzungen

• Go Version 1.18 oder höher
• Docker Desktop

Starten Sie den Postgres -Datenbankcontainer

Nachfolgend Befehle verwenden Docker, um den Datenbankcontainer zu starten.

make network
make postgres
make createdb

Erstellen Sie die Konfigurationsdatei aus der Vorlage

Die config.yaml ist die Konfigurationsvorlagendatei, die Standardkonfigurationswerte enthält.

cp config.yaml .config.yaml

Die Anwendung verwendet .config.yaml -Datei, um die Konfigurationswerte abzurufen. Bitte aktualisieren Sie Platzhalterwerte aus dieser Konfigurationsdatei auf die tatsächlichen.

Starten Sie den Server

Stellen Sie sicher, dass die Datei .config.yaml korrekt konfiguriert ist und der Datenbankcontainer ist hoch und ausgeführt. Führen Sie dann die folgenden Befehle aus, um das DB -Schema einzurichten und den Webserver zu starten.

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

Dadurch wird der Server auf der in .config.yaml -Datei angegebenen Port gestartet. Sie können jetzt auf die API -Endpunkte zugreifen.

Tests ausführen

go test -v -cover ./...

Dadurch wird alle Tests ausgeführt und auch den Prozentsatz der Codeabdeckung gedruckt.

Beitragsrichtlinien

Jeder Beitrag macht einen Unterschied

Lesen Sie die Beitragsrichtlinien, bevor Sie einen Beitrag leisten.

Besonderer Dank