diff --git a/.github/assets/banner.png b/.github/assets/banner.png deleted file mode 100644 index c3198fe..0000000 Binary files a/.github/assets/banner.png and /dev/null differ diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 0000000..243f590 Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..0e250e8 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,38 @@ +## 🚀 Contribute + +Bagaimana Cara Berkontribusi? +1. Fork Repository: + - Kalian bisa pergi ke [Repository kami](https://github.com/ngodeyuk/go-ngodeyuk-core-project). + - Klik tombol `Fork`di pojok kanan atas halaman. + - Ini akan membuat salinan repositori di akun GitHub kamu. + +2. Kemudian Clone Repository yang kamu fork: + ```bash + git clone https://github.com/username_kamu/NusantaraKita.git + cd NusantaraKita + ``` + +3. Buat Branch baru: + ```bash + git checkout -b nama-branch-kamu + ``` + +4. Lakukan Perubahan Kamu, contohnya: + - Tambahkan fitur baru atau perbaikan bug. + - Pastikan kode Anda mengikuti standar kode kami tanpa merubah semua strukturnya. + +5. Commit Perubahan kamu: + ### examples: + ```sh + git commit -m "chore(docs): improve documentation" + ``` + +6. Lalu Buat Pull Request: + - Pergi ke [Repository kami](https://github.com/ngodeyuk/NusantaraKita). + - Klik pada tab `Pull Request`. + - Klik `New Pull Request`. + - Pilih Branch fitur Anda dari dropdown "compare". + - Klik `Create Pull Request` dan berikan deskripsi perubahan Anda. + +> [!CAUTION] +> Pull request akan kami close jika langsung mengarah ke branch ``main``. \ No newline at end of file diff --git a/README.md b/README.md index f0d5293..9a1091d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ -![Logo GitHub](.github/assets/banner.png) # Nusantara Kita -Nusantara Kita adalah sebuah API yang menyediakan data wilayah Indonesia. Proyek ini dirancang untuk memudahkan akses dan penggunaan data geospasial terkait wilayah-wilayah di Indonesia. API ini dapat digunakan untuk berbagai aplikasi yang memerlukan informasi seperti batas wilayah, data administratif, dan lain-lain. \ No newline at end of file + +
+ +Nusantara Kita adalah sebuah API yang menyediakan data wilayah Indonesia. Proyek ini dirancang untuk memudahkan akses dan penggunaan data geospasial terkait wilayah-wilayah di Indonesia. API ini dapat digunakan untuk berbagai aplikasi yang memerlukan informasi seperti batas wilayah, data administratif, dan lain-lain. + +### 🧞 Running Project + +#### bagaimana menjalankan projectnya dilokal? + +- Setup Enviromentnya: + ```bash + mv env.example .env + ``` + lalu kemudian kamu isi sesuai dengan database kalian. + +- Install Requirements: + ```bash + pip install -r requirements.txt + ``` +- Menjalankan Jupyter Notebook nya: + ```bash + jupyter notebook + ``` + jalankan semua code yang ada di notebook untuk merubah dataset csv menjadi sql yang akan langsung diinsert ke database kalian. +- Menjalankan API nya: + ```bash + python main.py + ``` + +#### Ingin lebih mudah menjalankan databasenya, kamu bisa gunakan docker compose yang kami sediakan? + - Menjalankan Docker + ```bash + docker compose up -d + ``` + - Menghentikan Docker + ```bash + docker compose down + ``` +## 📖 Documentation +Untuk Dokumentasi cara menggunakan API nya, sudah kami sediakan ketika kamu sudah menjalankan project ini, langsung ajh buka endpoint url nya di browser kalian. + +## 🚀 Contribute + +Untuk berkontribusi di project ini, kamu bisa cek [disini](/CONTRIBUTE.md). Ayo berkontribusi bersama kami untuk membuat project ini menjadi lebih baik lagi. + +## ⚙️ License + +Project ini dilisensikan di bawah Lisensi MIT - lihat [LICENSE](/LICENSE) untuk detailnya. \ No newline at end of file