Belajar Testing Api menggunakan repo local : Cara Install Repo Updated

Halo, teman-teman! 👋. Sebelumnya saya sempat share repo foodtrip-api untuk testing api. Ternyata banyak yang kebingunan cara installnya dan menggunakannya. pada kesempatan ini saya coba jelaskan sedikit cara install dan cara menjalankan dilocal.

Salah satu alasan kenapa saya menyarakan testing menggunakan repo local karena seluruh test kita semua yang kontrol. Jadi kita tidak akan mengalamai keterbatasan dalam testing. Contoh umum jika kita menggunakan resouce online kita akan dibatasin hanya boleh hit api sekian x. jika melebihi maka kena limit. terus kadang jika kita menggunakan method POST dan DELETE biasanya dikembalikan dengan hanya random data. ok mungkin cukup intro-nya.😜

Cara install repo kali ini sedikit berbeda dengan yang saya share sebelumnya. Perbedaanya terletak pada db yang akan kita gunakan. sebelumnya kita mandatory harus mempunyai Xampp (atau lainnya) untuk menjalankan mysqlnya. namun kita sudah tidak perlu lagi karena repo sudah support dengan SQLite. Untuk yang belum tau SQLite itu apa silahkan baca disini ya.

Persiapan

Sebelum mulai menggunakan FoodTrip API, pastikan Anda telah melakukan persiapan berikut:

1. Install Node.js
   Pastikan Node.js versi 16 atau lebih baru sudah terpasang di komputer Anda.
   Download Node.js di sini
2. Install pnpm (opsional, direkomendasikan)
   pnpm adalah package manager yang lebih cepat dan efisien daripada npm.
   Instalasi pnpm:

   npm install -g pnpm

3. Siapkan Database

• Untuk pengembangan, Anda bisa langsung menggunakan SQLite (default, tanpa konfigurasi tambahan).
• Untuk simulasi db lainnya, siapkan gunakan database MySQL, PostgreSQL, MariaDB, atau MSSQL sesuai kebutuhan.
• Pastikan host, port, username, password, dan nama database yang akan digunakan.

3. Clone Repository
   Kloning repo ini ke komputer Anda:

   git clone https://github.com/fredysiswanto/foodtrip-api
   cd foodtrip-api

5. Salin dan Konfigurasi File Environment
   Salin file .env.example menjadi .env lalu sesuaikan konfigurasi di dalamnya sesuai kebutuhan Anda, terutama bagian database yang ingin digunakan.
6. Pastikan Port 3600 (atau yang Anda atur di .env) Tidak Digunakan Aplikasi Lain
   Jika port sudah digunakan, silakan ubah variabel PORT di file .env.

Cara Menggunakan Repo FoodTrip API

1. Clone Repository

Jalankan perintah berikut di terminal:

git clone https://github.com/fredysiswanto/foodtrip-api
cd foodtrip-api

2. Instalasi Dependensi

Pastikan Node.js (v16 ke atas) sudah terpasang. Install dependensi dengan:

pnpm install

Jika belum punya pnpm, bisa gunakan npm install.

3. Konfigurasi Environment

Salin file contoh environment:

cp .env.example .env

Edit file .env sesuai kebutuhan, misal pengaturan database, port, dan secret key.

4. Setup Database (hanya 1x Saat pertama install)

Untuk setup database secara otomatis :

pnpm run db:setup

Atau lakukan migrasi dan seeding manual:

pnpm run db:migrate
pnpm run db:seed

5. Menjalankan Server

Mulai server pengembangan dengan:

pnpm run dev

API akan berjalan di http://localhost:5000 (atau port yang Anda atur di .env).

6. Testing API

• Dokumentasi tambahan endpoint tersedia di folder docs dan test-case.
• Untuk pengujian manual, gunakan file test.http dengan ekstensi REST Client di VS Code.
• Import koleksi Postman FoodTrip.postman_collection.json untuk pengujian otomatis.

7. Linting & Format Kode (optional, hanya jika ada perubahan code saya)

Pastikan kode tetap rapi dengan:

pnpm run lint
pnpm run lint:fix
pnpm run format

note:

• Jika ada kendala, silakan buka issue di GitHub. atau bisa dm saya di Linkedin

Jalankan Server dan Testing API

kita masuk ke langkah menjalankan server local kita dengan cara mengetik printah pnpm dev. jika tidak ada error maka di terminal teman-teman akan muncul seperti dibawah ini. dan kita bisa lanjut melakukan testing dengan browser dengan mengakses url berikut : http://localhost:3600/api/v1/home/dishes/
Pastikan kamu masih berada di dalam folder repo, lalu ketik perintah berikut:

pnpm dev

Jika tidak ada error, terminal akan menunjukkan pesan bahwa server berjalan, misalnya di port 3600. Kamu bisa langsung coba akses API lewat browser atau Postman:

http://localhost:3600/api/v1/home/dishes/

Untuk mempermudah pengujian, kamu bisa mengimpor collection Postman yang sudah tersedia di repo.

---

🎯 Kesimpulan

Dengan mengikuti langkah-langkah di atas, kamu seharusnya sudah bisa menjalankan repo foodtrip-api secara lokal dan mulai melakukan testing API. Jangan lupa selalu baca file README.md untuk informasi tambahan!

Kalau masih ada yang bingung atau menemui kendala, jangan ragu buat komentar atau DM saya ya! 🚀

Selamat mencoba dan happy coding! 💻✨