novy/database-kesiswaan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add deployment, backup, and project documentation

Browse Source
This commit is contained in:
novy
2026-04-12 06:38:44 +00:00
parent 007f107be6
commit 33a74298b1
5 changed files with 995 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+273 -35
View File
@@ -1,58 +1,296 @@
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
# Database Kesiswaan
<p align="center">
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
</p>
Aplikasi administrasi sekolah berbasis **Laravel** untuk mengelola data siswa, dokumen siswa, data orang tua/wali, kenaikan kelas, mutasi/keluar siswa, portal publik pencarian siswa, dan portal pelengkapan biodata siswa.
## About Laravel
---
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
## Tujuan Aplikasi
- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
Project ini dibuat untuk membantu operasional sekolah dalam satu panel administrasi yang lebih rapi dan terstruktur, dengan fokus pada:
Laravel is accessible, powerful, and provides tools required for large, robust applications.
- pengelolaan data siswa
- master data akademik
- pengelolaan dokumen siswa
- pemantauan kelengkapan dan verifikasi dokumen
- histori akademik siswa
- promosi / kenaikan kelas
- arsip siswa keluar dan mutasi
- portal publik untuk pencarian informasi siswa
- portal publik untuk pelengkapan biodata siswa secara mandiri
## Learning Laravel
---
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
## Fitur Utama
In addition, [Laracasts](https://laracasts.com) contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
### Dashboard
- ringkasan jumlah siswa
- ringkasan kelengkapan dokumen
- ringkasan verifikasi dokumen
You can also watch bite-sized lessons with real-world projects on [Laravel Learn](https://laravel.com/learn), where you will be guided through building a Laravel application from scratch while learning PHP fundamentals.
### Master Data
- Tahun Angkatan
- Program Keahlian
- Kelas
- Jenis Dokumen
## Agentic Development
### Data Siswa
- CRUD data siswa
- detail siswa
- relasi ke Tahun Angkatan, Program Keahlian, dan Kelas
- histori akademik siswa
Laravel's predictable structure and conventions make it ideal for AI coding agents like Claude Code, Cursor, and GitHub Copilot. Install [Laravel Boost](https://laravel.com/docs/ai) to supercharge your AI workflow:
### Orang Tua / Wali
- nested CRUD di bawah siswa
- dukungan ayah, ibu, dan wali
### Dokumen Siswa
- upload dokumen
- edit / hapus dokumen
- preview browser
- download file
- verifikasi cepat dokumen
- catatan verifikasi
### Arsip Status Siswa
- Data Siswa Keluar
- Data Siswa Mutasi
- Data Siswa Lulus
### Promosi / Kenaikan Kelas
- rekomendasi kenaikan kelas
- penulisan histori akademik otomatis
### Portal Publik
- pencarian siswa publik
- portal pelengkapan biodata siswa
- verifikasi melalui NIS/NISN dan kode akses
### Pengaturan
- manajemen pengguna
- branding aplikasi
- reset data tertentu
---
## Teknologi yang Dipakai
- **Laravel**
- **Blade**
- **Tailwind CSS**
- **Vite**
- **MySQL / MariaDB**
- **SweetAlert2**
- **Alpine.js**
---
## Requirement Minimum
- PHP 8.2+
- Composer
- Node.js + npm
- MySQL / MariaDB
- Git
- Web server Apache atau Nginx
---
## Instalasi Lokal / Fresh Setup
### 1. Clone repository
```bash
composer require laravel/boost --dev
php artisan boost:install
git clone https://github.com/novysan87/database-kesiswaan.git
cd database-kesiswaan
```
Boost provides your agent 15+ tools and skills that help agents build Laravel applications while following best practices.
### 2. Copy file environment
```bash
cp .env.example .env
```
## Contributing
### 3. Edit konfigurasi `.env`
Sesuaikan terutama:
- `APP_URL`
- `DB_HOST`
- `DB_PORT`
- `DB_DATABASE`
- `DB_USERNAME`
- `DB_PASSWORD`
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
### 4. Jalankan script deploy
```bash
./deploy.sh
```
## Code of Conduct
Untuk staging:
```bash
APP_ENVIRONMENT=staging ./deploy.sh
```
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
Kalau perlu seeder:
```bash
RUN_SEED=true ./deploy.sh
```
## Security Vulnerabilities
---
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
## Menjalankan Secara Manual
## License
Kalau tidak memakai `deploy.sh`:
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
```bash
composer install
npm install
npm run build
php artisan key:generate
php artisan migrate
php artisan storage:link
```
Untuk development:
```bash
php artisan serve
npm run dev
```
---
## Backup
Project ini menyediakan script backup manual:
```bash
./backup.sh
```
Yang dibackup:
- database MySQL
- `storage/app/public`
- file `.env`
Lokasi backup default:
- `storage/app/backups-manual/database`
- `storage/app/backups-manual/storage`
- `storage/app/backups-manual/env`
---
## Deploy ke Server Baru
Panduan lengkap ada di file:
```bash
DEPLOY.md
```
Di sana sudah dibahas:
- fresh deploy
- update deploy
- setup web server
- storage link
- backup & restore dasar
- checklist verifikasi pasca deploy
---
## Struktur Penting Project
```bash
app/ # controller, model, middleware, logic aplikasi
config/ # konfigurasi Laravel
database/ # migration, seeder, factory
public/ # document root web server
resources/views/ # Blade views
routes/ # web route & auth route
storage/app/public/ # file upload runtime (tidak masuk git)
DEPLOY.md # panduan deploy server baru
deploy.sh # script deploy
backup.sh # script backup
```
---
## Catatan Penting
### Jangan upload ke GitHub:
- `.env`
- dump database produksi
- file upload produksi
- dokumen siswa
- log runtime
- cache runtime
- credential / token / secret
### Yang masuk GitHub:
- source code
- migration
- seeder
- konfigurasi contoh
- script deploy / backup
- dokumentasi
---
## Alur Deploy yang Direkomendasikan
### Fresh server
```bash
git clone <repo>
cd database-kesiswaan
cp .env.example .env
./deploy.sh
```
### Update aplikasi
```bash
cd /var/www/database-kesiswaan
git pull origin main
./deploy.sh
```
### Backup manual
```bash
cd /var/www/database-kesiswaan
./backup.sh
```
---
## Branding
Branding aplikasi bisa diatur dari dashboard melalui menu:
- **Pengaturan > Branding Aplikasi**
Pengaturan ini dapat mencakup:
- nama aplikasi
- nama singkat / inisial
- logo utama
- favicon
- logo portal publik
---
## Catatan Operasional
- source code di GitHub adalah **source of truth untuk code**
- data produksi tetap harus dibackup terpisah
- folder `storage/app/public` harus ikut dipindahkan saat migrasi server
- `php artisan storage:link` wajib tersedia agar file publik tampil normal
---
## Status Saat Ini
Project ini sudah memiliki fondasi deploy dasar:
- repository GitHub
- `DEPLOY.md`
- `deploy.sh`
- `backup.sh`
- `.env.example` yang lebih relevan
---
## Lisensi / Kepemilikan
Project ini adalah aplikasi internal/operasional yang dikembangkan untuk kebutuhan administrasi sekolah. Gunakan dan kelola repository dengan akses yang sesuai, idealnya **private repository**.