https://github.com/hind-sagar-biswas/php_launcher
It is a framework for PHP developers to get a quick start with their projects with the highest control and lowest learning curve!
https://github.com/hind-sagar-biswas/php_launcher
apache framework php-framework
Last synced: 6 months ago
JSON representation
It is a framework for PHP developers to get a quick start with their projects with the highest control and lowest learning curve!
- Host: GitHub
- URL: https://github.com/hind-sagar-biswas/php_launcher
- Owner: hind-sagar-biswas
- License: mit
- Created: 2023-09-06T18:25:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T21:07:38.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T07:38:24.815Z (8 months ago)
- Topics: apache, framework, php-framework
- Language: PHP
- Homepage:
- Size: 129 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Launcher
```bash
██████╗ ██╗ ██╗██████╗ ██╗ █████╗ ██╗ ██╗███╗ ██╗ ██████╗██╗ ██╗███████╗██████╗
██╔══██╗██║ ██║██╔══██╗ ██║ ██╔══██╗██║ ██║████╗ ██║██╔════╝██║ ██║██╔════╝██╔══██╗
██████╔╝███████║██████╔╝ ██║ ███████║██║ ██║██╔██╗ ██║██║ ███████║█████╗ ██████╔╝
██╔═══╝ ██╔══██║██╔═══╝ ██║ ██╔══██║██║ ██║██║╚██╗██║██║ ██╔══██║██╔══╝ ██╔══██╗
██║ ██║ ██║██║ ███████╗██║ ██║╚██████╔╝██║ ╚████║╚██████╗██║ ██║███████╗██║ ██║
╚═╝ ╚═╝ ╚═╝╚═╝ ╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝
```
It is a pseudo-framework for PHP developers to get a quick start with their projects with the highest control and lowest learning curve!
## Table of Contents
- [PHP Launcher](#php-launcher)
- [Table of Contents](#table-of-contents)
- [Getting started](#getting-started)
- [Step 1: Installation](#step-1-installation)
- [Declare custom routes:](#declare-custom-routes)
- [Step 1: Enable custom router](#step-1-enable-custom-router)
- [Step 2: Create routes](#step-2-create-routes)
- [Move to raw routes:](#move-to-raw-routes)
- [step 1: Enable raw router](#step-1-enable-raw-router)
- [Debugging](#debugging)
- [Dump](#dump)
- [Die Dump](#die-dump)
- [Including static files](#including-static-files)
- [1.Images](#1images)
- [2. CSS](#2-css)
- [3. JS](#3-js)
- [4. \[node\_module\] CSS](#4-node_module-css)
- [5. \[node\_module\] JS](#5-node_module-js)
- [CSRF Protection](#csrf-protection)
- [!! Enable Csrf](#-enable-csrf)
- [Include CSRF token to Forms](#include-csrf-token-to-forms)
___
## Getting started
### Step 1: Installation
We have our own installer software which eases the installation process via which you can get started with your projects with a few clicks. The installer is called [PL Installer](https://github.com/hind-sagar-biswas/pl_installer). Go to the repo, then go to [Releases](https://github.com/hind-sagar-biswas/pl_installer/releases) and download binary/exe from the latest release. After downloading, just run it and follow the instructions and you are done!
## Declare custom routes:
### Step 1: Enable custom router
To enable controlled/custom routes insted of filesystem,go to `/shell/.ev` and change the value of `APP_ROUTE_SYSTEM` to the follwing
```env
APP_ROUTE_SYSTEM=controlled
```
### Step 2: Create routes
To declare routes go to `/shell/routes/`.In there, there are 2 files i.e `web.php` [that controlls norma routes where response is html] and `api.php` [which controlls api routes for urls starting with `/api/` and response type is JSON].The files content looks like this:
```php
add_routes(
Router::get('/')->name('home')->call('index'),
);
```
There, use `Router::get('/route/path/')-name('route.name')->call('file.name')` format to declare new routes
## Move to raw routes:
### step 1: Enable raw router
To enable raw/filesystem based routes insted of declarative and controlled ones, go to `/shell/.env` and change the value of `APP_ROUTE_SYSTEM` to the following
```env
APP_ROUTE_SYSTEM=raw
```
Now the routes will follow the name of the file, `url/path/to/filename/` will output the contents of `./facade/path/to/filename.php`
## Debugging
### Dump
To dump variables, use `d()` function
### Die Dump
To dump variables and stop execution, use `dd()` function
## Including static files
Static files are kept in either `./assets/` or `./node_modules/` directory. CSS, JS and Images are in respectively `/css/`, `/js/` and `/images/ ` directory inside `./assets/`
### 1.Images
Use `_image()` function to get the path
```blade
%20?>)
```
### 2. CSS
Use `_css()` function to get the css inclusion code
```php
```
### 3. JS
Use `_js()` function to get the js inclusion code
```php
```
### 4. [node_module] CSS
Use `_node_css()` function to get the css inclusion code
```php
```
### 5. [node_module] JS
Use `_node_js()` function to get the js inclusion code
```php
// output:
//
```
## CSRF Protection
## !! Enable Csrf
First enable csrf from `.env` file and to do that, go to ` /shell/.env` and change the value of `CSRF_ENABLED` to the following
```env
CSRF_ENABLED=true
```
## Include CSRF token to Forms
CSRF protection is only needed in `post ` requests. So, you need to include the CSRF token as a hidden input element in every `form:post` forms. To do that just call `_csrf()` function.
```blade
```