From 412f17e1b402773571c2308116d7e47df8f12279 Mon Sep 17 00:00:00 2001 From: Ryanda Valents Anakri <143876980+ryandaaa@users.noreply.github.com> Date: Fri, 26 Dec 2025 19:19:15 +0700 Subject: [PATCH] Refactor README for better organization and clarity Updated the README to improve structure and content clarity. --- README.md | 60 ++++++++++++++++++++++++++----------------------------- 1 file changed, 28 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index e0ae8ad..a1583e3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,4 @@ -
-
-
Modern Academic Information System built with Laravel 12 @@ -28,24 +24,24 @@ --- -## ๐ Overview +## Overview **SIAKAD** (Sistem Informasi Akademik) adalah aplikasi manajemen akademik modern yang dirancang untuk universitas dan perguruan tinggi. Dibangun dengan Laravel 12 dan menggunakan arsitektur yang clean, scalable, dan production-ready. -### โจ Highlights +### Highlights -- ๐จ **Modern UI** - Responsive design dengan TailwindCSS dan Alpine.js -- ๐ค **AI-Powered** - Academic Advisor berbasis Gemini AI -- ๐ **Secure** - Role-based access control, rate limiting, dan security headers -- โก **Fast** - Optimized queries, caching strategy, dan database indexes -- ๐ฑ **Responsive** - Mobile-friendly interface -- ๐ **Indonesian Locale** - Fully localized untuk bahasa Indonesia +- **Modern UI** - Responsive design dengan TailwindCSS dan Alpine.js +- **AI-Powered** - Academic Advisor berbasis Gemini AI +- **Secure** - Role-based access control, rate limiting, dan security headers +- **Fast** - Optimized queries, caching strategy, dan database indexes +- **Responsive** - Mobile-friendly interface +- **Indonesian Locale** - Fully localized untuk bahasa Indonesia --- -## ๐ Features +## Features -### ๐จโ๐ Mahasiswa +### Mahasiswa | Feature | Description | |---------|-------------| | **KRS Online** | Pengisian Kartu Rencana Studi dengan validasi SKS otomatis | @@ -59,7 +55,7 @@ | **Kerja Praktek** | Manajemen KP dan logbook | | **Export PDF** | Download transkrip dan KHS dalam format PDF | -### ๐จโ๐ซ Dosen +### Dosen | Feature | Description | |---------|-------------| | **Input Nilai** | Input nilai mahasiswa per kelas | @@ -70,7 +66,7 @@ | **LMS Management** | Upload materi dan kelola tugas | | **Kehadiran** | Absensi kehadiran dosen | -### ๐จโ๐ผ Admin +### Admin | Feature | Description | |---------|-------------| | **Dashboard** | Statistik dan overview akademik | @@ -81,7 +77,7 @@ | **Ruangan** | Manajemen ruang kuliah | | **Kehadiran Dosen** | Monitoring kehadiran dosen | -### ๐ Security Features +### Security Features - โ Role-based access control (RBAC) - โ Faculty-scoped admin access - โ Rate limiting pada endpoint sensitif @@ -91,7 +87,7 @@ --- -## ๐ Tech Stack +## Tech Stack ### Backend | Technology | Version | Description | @@ -122,7 +118,7 @@ --- -## ๐ฆ Installation +## Installation ### Prerequisites @@ -261,7 +257,7 @@ return [ --- -## ๐ฅ Default Users +## Default Users After running seeders, you can login with: @@ -272,11 +268,11 @@ After running seeders, you can login with: | **Dosen** | `dosen@siakad.test` | `password` | Dr. Ahmad Fauzi, M.Kom. | | **Mahasiswa** | `mahasiswa@siakad.test` | `password` | Budi Santoso (Semester 5, NIM: 2022101001) | -> โ ๏ธ **Important**: Change these passwords immediately in production! +> **Important**: Change these passwords immediately in production! --- -## ๐ Project Structure +## Project Structure ``` siakad/ @@ -312,7 +308,7 @@ siakad/ --- -## ๐๏ธ Database Schema +## Database Schema ### Core Tables @@ -377,7 +373,7 @@ siakad/ --- -## ๐ง Artisan Commands +## Artisan Commands ```bash # Cache warming (after deployment) @@ -398,7 +394,7 @@ php artisan migrate:fresh --seed --- -## ๐งช Testing +## Testing ```bash # Run all tests @@ -413,7 +409,7 @@ php artisan test --coverage --- -## ๐ Security +## Security ### Rate Limiting - AI Chat: 10 requests/minute per user @@ -432,7 +428,7 @@ php artisan test --coverage --- -## ๐ Performance +## Performance ### Optimizations - Database indexes on frequently queried columns @@ -452,7 +448,7 @@ php artisan test --coverage --- -## ๐ค Contributing +## Contributing Contributions are welcome! Please feel free to submit a Pull Request. @@ -470,15 +466,15 @@ Contributions are welcome! Please feel free to submit a Pull Request. --- -## ๐ License +## License This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). --- -## ๐จโ๐ป Author +## Author -Developed with โค๏ธ for academic purposes. +Developed with โค๏ธ by Ryanda ---