diff --git a/README.md b/README.md index f30d0be..b2d2416 100644 --- a/README.md +++ b/README.md @@ -1,110 +1,69 @@ -# Flight PHP Skeleton App +# INVESA -Use this skeleton application to quickly setup and start working on a new Flight PHP application. This application uses the latest version of Flight PHP v3. +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). -This skeleton is designed to be AI-friendly out of the box, with predefined instructions files for popular AI coding assistants such as GitHub Copilot, Cursor, and Windsurf. This helps streamline development and ensures your project is ready for modern, AI-assisted workflows. +Ini adalah versi fork yang telah disesuaikan dengan kebutuhan dari Toko Cahaya Masa - Mempawah. -This skeleton application was built for Composer. You also could download a zip of this repo, downloading a zip of the [flightphp/core](https://github.com/flightphp/core) repo, and manually autoload the files by running `require('flight/autoload.php')` in your `app/config/# FlightPHP Skeleton Project Instructions +## Instalasi -This document provides guidelines and best practices for structuring and developing a project using the FlightPHP framework. - -## Installation - -Run this command from the directory in which you want to install your new Flight PHP application. (this will require PHP 7.4 or newer) +Aplikasi ini membutuhkan nginx sebagai proxy web server dan PHP versi 8.3 (keatas). ```bash -composer create-project flightphp/skeleton cool-project-name +git clone https://git.trifonia.cloud/CMASA-MEMPAWAH/cmasa.git ``` -Replace `cool-project-name` with the desired directory name for your new application. +Setelah berhasil clone, pastikan `app/config/app.php` dan `.env` telah disalin dan disesuaikan sesuai kebutuhan. -After you create the project, make sure you go to the `app/config/config.php` and `app/config/services.php` and uncomment the lines related to the database you want to use before you get started. +## Menjalankan Aplikasi -> _Tip: This skeleton includes configuration files for AI coding assistants (Copilot, Cursor, Windsurf) to help you get the most out of AI-driven development tools from the start._ +### Tanpa perlu install aplikasi tambahan -### Robust Setup of the Application - -This skeleton will come with 2 versions of a starter application. The robust version is a fully structured application meant for projects that you anticipate will be a bigger size. This is setup with object oriented programming in mind so that it is easier to unit test and scale your project with multiple developers (or make it easier on yourself). - -The robust version adds an `app/` directory where everything has a basic structure. This is how this skeleton is configured by default.meant - -### Simple Setup of the Application - -This is basically a single file application. The only exception to this is the config file which is still in the `app/config/` directory. This is a good starting point for smaller projects or projects that you don't anticipate will grow much. - -To use the simple version, you'll need to move the `index-simple.php` file to the `public/` directory and rename it to `index.php`. You can delete any other controllers, views, or config files (except the `config.php` file of course). - -With the simple setup, there is two very import security steps to be aware of. -- **DO NOT SAVE SENSITIVE CREDENTIALS TO THE `index.php` FILE**. -- **DO NOT COMMIT ANY TYPE OF SENSITIVE CREDENTIALS TO YOUR REPOSITORY**. - -This is what the config file is for. If you need to save sensitive credentials, save them to the config file and then reference them in the `index.php` file. - -## Running the Application - -### No Dependency Setup - -To run the application in development, you can run these commands +Untuk menjalankan aplikasi dalam bentuk pengembangan (development), anda bisa jalankan perintah ```bash -cd cool-project-name +cd cmasa composer start ``` -After that, open `http://localhost:8000` in your browser. +Setelah itu, buka `http://localhost:8000` di browser anda. -__Note: If you run into an error similar to this `Failed to listen on localhost:8000 (reason: Address already in use)` then you'll need to change the port that the application is running on. You can do this by editing the `composer.json` file and changing the port in the `scripts.start` key.__ +__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.__ -### Docker Setup +### Instalasi dengan Docker -You can [install Docker](https://docs.docker.com/engine/install/) and use `docker-compose` to run the app with `docker`, so you can run these commands: +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 cool-project-name +cd cmasa docker-compose up -d # or if a newer version of docker docker compose up -d ``` -After that, open `http://localhost:8000` in your browser. +Setelah itu, buka `http://localhost:8000` di browser anda. -### Vagrant Setup -You can [install Vagrant](https://vagrantup.com/download) and a provider like [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and use simple run the following command to bring up an environment with PHP/MariaDB already setup based on [n0nag0n/firefly](https://github.com/n0nag0n/firefly) +## Struktur Project -```bash -cd cool-project-name -vagrant up -``` - -After that, open `http://localhost:8000` in your browser. - -## Project Structure - -This skeleton is organized for clarity and maintainability, and is also structured to be easily navigable by AI coding assistants. The following layout is recommended: +Project ini dibuat dengan struktur yang mempermudah untuk maintenance dan dibaca oleh AI. berikut adalah struktur nya : ``` -project-root/ +cmasa/ │ -├── app/ # Application-specific code -│ ├── controllers/ # Route controllers (e.g., HomeController.php) -│ ├── middlewares/ # Custom middleware classes/functions -│ ├── models/ # Data models (if needed) -│ ├── utils/ # Utility/helper functions -│ ├── views/ # View templates (if using) +├── 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.) -│ -├── config/ # Configuration files (database, app settings, routes) +├── public/ # Web root (index.php, assets, etc.) (FE) │ ├── vendor/ # Composer dependencies │ -├── tests/ # Unit and integration tests +├── temp/ # Cache, Session, Error Logs │ ├── composer.json # Composer config │ └── README.md # Project overview ``` - -> _Predefined instructions for AI tools are included in this skeleton, making it easier for AI assistants to understand and help you with this structure._ - -## Do it! -That's it! Go build something flipping sweet!