0.0.4 • Published 8 months ago

api-jkt48connect v0.0.4

Weekly downloads
-
License
MIT
Repository
-
Last release
8 months ago

JKT48Connect API - Automatisasi Start Server

Panduan ini menjelaskan cara menjalankan server JKT48Connect API menggunakan script otomatis. Pengguna hanya perlu menjalankan script start.sh untuk memulai server.

Langkah-langkah

1. Buat File start.sh

Untuk memulai aplikasi, pertama buat file script start.sh di direktori utama proyek Anda dengan isi berikut:

#!/bin/bash

# Masuk ke dalam direktori api-jkt48connect
cd node_modules/api-jkt48connect

# Jalankan perintah node .
node .

2. Berikan Izin Eksekusi pada File Script

Setelah file start.sh dibuat, beri izin eksekusi pada file tersebut dengan perintah:

chmod +x start.sh

3. Tambahkan API Key

Sebelum menjalankan aplikasi, Anda harus menambahkan API key Anda. Anda dapat melakukannya dengan membuka file apiKeys.js yang ada dalam direktori node_modules/api-jkt48connect/ dan menambahkan API key Anda seperti contoh berikut:

module.exports = {
    apiKey: 'YOUR_API_KEY_HERE',
    expiryDate: '2024-12-31' // Tanggal kadaluarsa API Key, sesuaikan dengan kebutuhan
};

4. Jalankan Aplikasi

Sekarang, Anda dapat menjalankan server API JKT48Connect dengan perintah berikut:

./start.sh

Perintah ini akan secara otomatis masuk ke dalam direktori node_modules/api-jkt48connect dan menjalankan server Express yang menghosting API.

5. Akses API

Setelah server berjalan, Anda dapat mengakses API melalui browser atau aplikasi pengujian API seperti Postman.

  • Endpoint API:
    • /events – Mengambil data semua event yang tersedia.
    • /theater – Mengambil data semua theater.
    • /theater/:id – Mengambil data theater berdasarkan ID.
    • /news – Mengambil berita terbaru.
    • /news/:id – Mengambil detail berita berdasarkan ID.
    • /member/:name – Mengambil data member berdasarkan nama.
    • /live – Mengambil data live yang sedang berlangsung.

Contoh endpoint: http://localhost:3000/members

Catatan

  • Pastikan Anda telah menginstal semua dependencies yang diperlukan sebelum menjalankan aplikasi.
  • Jika terjadi masalah, pastikan Anda telah memberikan izin eksekusi pada file start.sh dan telah mengikuti langkah-langkah dengan benar.
### Penjelasan:
- **API Key**: Pengguna diminta menambahkan API key pada file `apiKeys.js` di direktori modul.
- **Expiry Date**: Pengguna dapat menyesuaikan tanggal kadaluarsa API key seperti contoh yang ada.
- **Endpoint**: Menyediakan daftar 7 endpoint API yang bisa digunakan.
0.0.4

8 months ago

0.0.3

8 months ago

0.0.2

8 months ago