115 lines
2.6 KiB
Markdown
115 lines
2.6 KiB
Markdown
# 📚 Dokumentasi Aplikasi Pengering Ikan
|
|
|
|
## 📄 File Dokumentasi
|
|
|
|
### 1. **README.md** (Dokumentasi Utama)
|
|
**Isi:**
|
|
- Overview aplikasi
|
|
- Arsitektur sistem
|
|
- Quick start guide
|
|
- Troubleshooting
|
|
- Tech stack
|
|
|
|
**Untuk:** Developer & user baru
|
|
|
|
---
|
|
|
|
### 2. **APK_MONITORING_FINAL.md** (Panduan Aplikasi)
|
|
**Isi:**
|
|
- Fitur aplikasi lengkap
|
|
- Cara install & test
|
|
- Penjelasan UI
|
|
- Notifikasi system
|
|
- Testing checklist
|
|
|
|
**Untuk:** User yang install APK
|
|
|
|
---
|
|
|
|
### 3. **PERBAIKAN_APK_FINAL.md** (Changelog)
|
|
**Isi:**
|
|
- Masalah yang diperbaiki
|
|
- Perubahan fitur
|
|
- Update history
|
|
- Technical details
|
|
|
|
**Untuk:** Developer & maintenance
|
|
|
|
---
|
|
|
|
### 4. **PERBAIKAN_STATUS_MQTT.md** (API Only)
|
|
**Isi:**
|
|
- Penjelasan kenapa MQTT dihapus
|
|
- Cara kerja API polling
|
|
- Status icon
|
|
- Troubleshooting koneksi
|
|
|
|
**Untuk:** User yang bertanya tentang MQTT
|
|
|
|
---
|
|
|
|
### 5. **backend/API_DOCUMENTATION.md** (API Reference)
|
|
**Isi:**
|
|
- Semua endpoint API
|
|
- Request/response format
|
|
- Error handling
|
|
- Testing dengan curl/Postman
|
|
|
|
**Untuk:** Developer backend & integration
|
|
|
|
---
|
|
|
|
## 🗂️ Struktur Folder
|
|
|
|
```
|
|
aplikasi_novil/
|
|
├── README.md ← Baca ini dulu!
|
|
├── APK_MONITORING_FINAL.md ← Panduan install APK
|
|
├── PERBAIKAN_APK_FINAL.md ← Changelog
|
|
├── PERBAIKAN_STATUS_MQTT.md ← Penjelasan API only
|
|
├── DOKUMENTASI.md ← File ini
|
|
│
|
|
├── backend/
|
|
│ ├── API_DOCUMENTATION.md ← API reference
|
|
│ ├── server.js ← Backend code
|
|
│ ├── database.js ← Database config
|
|
│ └── ...
|
|
│
|
|
├── lib/ ← Flutter app code
|
|
│ ├── screens/ ← UI screens
|
|
│ ├── services/ ← API & notification
|
|
│ └── models/ ← Data models
|
|
│
|
|
├── esp32_pengering_ikan_railway.ino ← ESP32 code
|
|
└── build-with-icon.ps1 ← Build script
|
|
```
|
|
|
|
---
|
|
|
|
## 🚀 Quick Links
|
|
|
|
### Untuk User:
|
|
1. **Install APK** → Baca `APK_MONITORING_FINAL.md`
|
|
2. **Masalah koneksi** → Baca `PERBAIKAN_STATUS_MQTT.md`
|
|
3. **Overview** → Baca `README.md`
|
|
|
|
### Untuk Developer:
|
|
1. **Setup project** → Baca `README.md`
|
|
2. **API integration** → Baca `backend/API_DOCUMENTATION.md`
|
|
3. **Changelog** → Baca `PERBAIKAN_APK_FINAL.md`
|
|
|
|
---
|
|
|
|
## 📝 Catatan
|
|
|
|
- Semua file MD lama sudah dihapus (36 files)
|
|
- Hanya tersisa 5 file penting
|
|
- Dokumentasi lebih rapi dan terorganisir
|
|
- Mudah dicari dan dipahami
|
|
|
|
---
|
|
|
|
**Last Updated:** 1 Juni 2026
|
|
**Total Docs:** 5 files
|
|
**Status:** ✅ Clean & Organized
|