diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..aa28c09 --- /dev/null +++ b/readme.md @@ -0,0 +1,55 @@ +# API ANTRIAN OPERASI + +REST API menggunakan GO dengan framework GIN + +## Tech Stack + +- Go +- Gin +- PostgreSQL +- Docker Compose +- Swagger (swaggo) + +## Struktur Folder +``` +api-service/ +├── 📁 cmd/ +│ ├── api/main.go # Entry points aplikasi +├── 📁 docs/ # Output Dokumentasi swagger +├── 📁 internal/ +| |__ config/ # File konfigurasi +| |__ database/ # Package fungsi database (connection, execution, etc) +| |__ domain/ # Core business logic +| |__ middleware/ # Package middleware +| |__ routes/ # Wiring untuk register semua routing yang dipakai +| |__ server/ # Inisiasi server API +| |__ shared/ # Fungsi umum yang bisa digunakan di berbagai domain +| |__ utils/ # Fungsi utilisasi untuk query builder +├── 📁 migrations/ # Folder query database (test-purpose) +| |__ DDL.sql/ +| |__ seeds.sql/ + +```` + +## Instalasi go package + +```bash +cd + +go mod tidy +``` + +## Menjalankan postgres di docker +Jika menggunakan windows, pastikan docker desktop sudah berjalan. +````bash +docker compose up -d +```` + +## Generate dokumentasi swagger +Pastikan sudah menulis komentar dengan format dari swagger di handler endpoint +````bash +// masuk ke root project +cd + +swag init -g cmd/api/main.go -o docs +```` \ No newline at end of file