Files
cmasa/README.md
T

70 lines
2.5 KiB
Markdown

# INVESA
INVESA adalah Aplikasi Stok dan Penjualan POS, yang dibangun dengan basis [flightphp/core](https://github.com/flightphp/core) dan [siaupheng/webapp](https://git.trifonia.cloud/siaupheng/webapp).
Ini adalah versi fork yang telah disesuaikan dengan kebutuhan dari Toko Cahaya Masa - Mempawah.
## Instalasi
Aplikasi ini membutuhkan nginx sebagai proxy web server dan PHP versi 8.3 (keatas).
```bash
git clone https://git.trifonia.cloud/CMASA-MEMPAWAH/cmasa.git
```
Setelah berhasil clone, pastikan `app/config/app.php` dan `.env` telah disalin dan disesuaikan sesuai kebutuhan.
## Menjalankan Aplikasi
### Tanpa perlu install aplikasi tambahan
Untuk menjalankan aplikasi dalam bentuk pengembangan (development), anda bisa jalankan perintah
```bash
cd cmasa
composer start
```
Setelah itu, buka `http://localhost:8000` di browser anda.
__Catatan: Jika anda menemukan pesan error seperti `Failed to listen on localhost:8000 (reason: Address already in use)` maka anda dapat mengubah port aplikasi untuk dijalankan di port berbeda. Anda dapat mengubah pada file `composer.json` di bagian port bagian `scripts.start` ini.__
### Instalasi dengan Docker
Anda dapat [install Docker](https://docs.docker.com/engine/install/) dan gunakan `docker-compose` untuk menjalankan aplikasi dengan `docker`, jadi anda jalankan perintah berikut :
```bash
cd cmasa
docker-compose up -d
# or if a newer version of docker
docker compose up -d
```
Setelah itu, buka `http://localhost:8000` di browser anda.
## Struktur Project
Project ini dibuat dengan struktur yang mempermudah untuk maintenance dan dibaca oleh AI. berikut adalah struktur nya :
```
cmasa/
│
├── app/ # Folder utama aplikasi (BE)
│ ├── Controllers/ # Route controllers
│ ├── Middlewares/ # Custom middleware classes/functions
│ ├── Scripts/ # Script JS for every Controllers
│ ├── Styles/ # Extra CSS Styles
│ ├── Utils/ # Utility/helper functions
│ ├── views/ # View templates
│ ├── config/ # Configuration files (database, app settings, routes)
│ └── commands/ # Custom CLI commands for Runway
│
├── public/ # Web root (index.php, assets, etc.) (FE)
│
├── vendor/ # Composer dependencies
│
├── temp/ # Cache, Session, Error Logs
│
├── composer.json # Composer config
│
└── README.md # Project overview
```