# pine

**Repository Path**: wfdaj/pine

## Basic Information

- **Project Name**: pine
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: 0.x
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-02
- **Last Updated**: 2023-12-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Pine: A PHP Framework
## About Pine

Pine is a minimal PHP Web Framework

## Important
This is just a hobby project and is not complete in any way.

If you are looking for a framework that is production compatible, check out [Laravel](https://github.com/laravel/laravel/)

This is not meant to be used in a production environment.

On the other hand, if you stumble upon any issues (which I assume are plenty), please open an issue on github so I can take a look at it.

## Prerequisites
- PHP 8.2.10
- Composer 2.6.2
- Node 20.6.1 (Optional, only needed for vite/bun)
- Bun 1.0 (Optional, only needed for vite)

## Installation

First clone the repository
```sh
$ git clone https://github.com/raahimfareed/pine.git
```

Install composer packages
```sh
$ composer install
```

Optional: If you intend on using ViteJS, you can install all js packages

We use bun for this
```sh
$ bun install
```

Run PHP server
```sh
$ php -S localhost:8000
```

This will run a php server on localhost with port 8000

In a new terminal window, start vite

```sh
$ bun run dev
```

## Routing

You can create more routes in `src/routes.php`

For now, only GET and POST methods are supported, more methods will be added in future.

## Views and Leaf Templates

Views are essentially HTML files with added template functionalities.

You can create more views in `src/views` directory with the format `filename.leaf.html`

All view files should have an extension of `.leaf.html`

When rendering a view in routes, you will need to enter the view path relative to the view folder and without the extension

For example, with a project structure of the following
```sh
./src/
├── App
│   ├── LeafTemplateEngine.php
│   ├── Request.php
│   ├── Route.php
│   └── View.php
├── config
│   └── bootstrap.php
├── routes.php
└── views
    └── test.leaf.html
```

We have a test.leaf.html

We can simple render this

```php
Route::get("/", function () {
    return new View("test");
});
```

### Showing data in pages

You can pass data to your templates as well using an optional 2nd argument to the View class.

Looking at the previous example, we would write it as

```php
Route::get("/", function () {
    return new View("test", ["name" => "Chuck Norris"]);
});
```

And then you can access it in your leaf file

```html
<h1>{{name}}</h1>
```

### CSS and JS
Pine serves `public/style.css` and `public/main.js` files for css and js respectively

You just need to add @css and @js directives in your leaf file if you need these files.

If you are using Vite, you will need to edit `src/resources/js/index.js` and `src/resources/css/index.css`
as vite will automatically bundle js and css for you, you will still need @css and @js to add it into your html

## Migrations and Models
Models and migrations are in the making, **coming soon**