Tujuan dari proyek ini adalah membuat API untuk kamus Bahasa Banjar-Indonesia, yang memberikan pengguna kemampuan untuk menerjemahkan kata dari Bahasa Banjar ke Bahasa Indonesia. Penjelasan secara teori tentang bahasa Banjar silakan merujuk ke halaman wiki.

Baca dengan bahasa lain: English.

Proyek ini dibangun menggunakan Go version 1.22.2, dan diharapkan untuk dikembangkan menggunakan versi Golang yang serupa untuk mendapatkan hasil sesuai harapan.

Catatan: Endpoint auth, komunitas (write), kontribusi, dan admin membutuhkan MySQL (MYSQL_DSN harus diset). Tanpa MySQL, hanya endpoint kamus publik (/alphabets, /entries) yang terdaftar.

# Dengan MySQL
MYSQL_DSN="user:pass@tcp(localhost:3306)/kamusbanjar" \
JWT_SECRET="your-secret-key-at-least-32-chars" \
go run .

# Hanya kamus (tanpa MySQL)
go run .

Jalankan perintah berikut untuk melakukan test:

go test -v -cover ./...

Untuk integration test (membutuhkan database MySQL test):

TEST_MYSQL_DSN="user:pass@tcp(localhost:3306)/kamusbanjar_test" \
go test -tags=integration -v ./integration/...

Jalankan perintah berikut untuk membuat file biner:

go build -ldflags "-s -w" -o ./bin/app .

Kemudian jalankan menggunakan perintah ./bin/app.

Jalankan migrasi secara berurutan:

mysql -u user -p kamusbanjar < database/migrations/001_schema.sql
mysql -u user -p kamusbanjar < database/seeds/002_seed.sql
mysql -u user -p kamusbanjar < database/migrations/003_refresh_tokens.sql
mysql -u user -p kamusbanjar < database/migrations/004_word_source.sql
mysql -u user -p kamusbanjar < database/migrations/005_contributions.sql
mysql -u user -p kamusbanjar < database/migrations/006_community.sql

Atau gunakan Docker Compose yang otomatis menjalankan semua migrasi saat pertama kali dijalankan.

cp .env.dev.example .env.dev
docker compose -f docker-compose.dev.yml --env-file .env.dev up -d

API tersedia di http://localhost:8001. MySQL tersedia di localhost:3306.
Untuk wipe dan re-seed: docker compose -f docker-compose.dev.yml down -v

Jalankan Traefik terlebih dahulu:

cd traefik/ && docker compose up -d && cd ..

Kemudian:

cp .env.example .env
# Edit .env — wajib: DOMAIN, MYSQL_ROOT_PASSWORD, MYSQL_PASSWORD, JWT_SECRET
docker compose up -d

API tersedia di https://<DOMAIN> dengan TLS otomatis dari Let's Encrypt.
Untuk wipe dan re-seed: docker compose down -v

Mengembalikan semua daftar alfabet.

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": [
    {
      "letter": "a",
      "total": 3
    }
  ],
  "message": "All alphabets successfully retrieved.",
  "status": "success"
}

Respon akan dikembalikan dalam bentuk JSON juga jika terdapat galat. Contohnya:

{
    "code": 500,
    "message": "Internal Server Error",
    "status": "error"
}

Mengembalikan daftar kosakata bahasa Banjar berdasarkan alfabet yang diberikan.

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": {
    "letter": "a",
    "total": 3,
    "words": [
      "abadan",
      "abah",
      "abat"
    ]
  },
  "message": "All words with letter 'a' successfully retrieved.",
  "status": "success"
}

Mengembalikan definisi dan arti dari kosakata bahasa Banjar yang diberikan.

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": {
    "word": "abah",
    "alphabet": "a",
    "meanings": [
      {
        "definitions": [
          {
            "definition": "ayah",
            "partOfSpeech": "n"
          }
        ]
      }
    ]
  },
  "message": "Definition of word 'abah' successfully retrieved.",
  "status": "success"
}

• Departemen Pendidikan Nasional, Pusat Bahasa, Balai Bahasa Banjarmasin. 2008. Kamus Bahasa Banjar Dialek Hulu-Indonesia. Banjarbaru.
• Pusat Pembinaan dan Pengembangan Bahasa, Departemen Pendidikan dan Kebudayaan. 1977. Kamus Banjar-Indonesia. Jakarta.

Kamus Banjar API adalah perangkat lunak open-source yang dilisensikan di bawah lisensi MIT license.