batnoter api

Modul API Batnoter

Ini adalah layanan API dari aplikasi Batnoter yang dibangun dengan Golang.

Ini memperlihatkan titik akhir istirahat untuk mengakses dan mengelola catatan penurunan harga dari repositori git pengguna. Saat ini hanya mendukung repositori GitHub untuk menyimpan & mengelola catatan.

Pengaturan Pengembangan Lokal

Prasyarat

• GO Versi 1.18 atau lebih
• Desktop Docker

Mulai Wadah Database Postgres

Perintah di bawah menggunakan Docker untuk memulai wadah database.

make network
make postgres
make createdb

Buat file konfigurasi dari template

config.yaml adalah file templat konfigurasi yang berisi nilai konfigurasi default.

cp config.yaml .config.yaml

Aplikasi menggunakan file .config.yaml untuk mendapatkan nilai konfigurasi. Harap perbarui nilai placeholder dari file konfigurasi ini ke yang sebenarnya.

Mulai server

Pastikan file .config.yaml dikonfigurasi dengan benar & wadah database sedang berjalan & berjalan. Kemudian jalankan perintah di bawah ini untuk mengatur skema DB dan memulai server web.

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

Ini akan memulai server pada port yang ditentukan dalam file .config.yaml . Anda sekarang dapat mengakses titik akhir API.

Jalankan tes

go test -v -cover ./...

Ini akan menjalankan semua tes dan juga mencetak persentase cakupan kode.

Pedoman Kontribusi

Setiap kontribusi membuat perbedaan

Baca pedoman kontribusi sebelum Anda berkontribusi.

Terima kasih khusus