Download the PHP package abollinger/partez without Composer
On this page you can find all versions of the php package abollinger/partez. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download abollinger/partez
More information about abollinger/partez
Files in abollinger/partez
Package partez
Short Description A simple & fast PHP starter kit for web app
License MIT
Homepage https://github.com/Antoine-Bollinger/partez
Informations about the package partez
A simple & fast PHP starter kit for web app.
π Report Bug | See on Packagist π¦οΈ
partez
is a PHP starter kit designed to help developers quickly set up and manage a PHP web application. It includes robust backend support with streamlined front-end automation via bricolo
, a JS package that compiles assets, serves your app, and provides live reloading for a smooth development workflow.
- Getting Started
- Requirements
- Installation and Setup
- How It Works
- Configuration
- The Router
- The Pages
- The Public Folder
- The API
- Bricolo JS Automation
- Configuration
- Usage
- Built With
- Contributing
- Contact
Getting started
Requirements
- Composer for backend dependency management.
- Node.js (v12 or higher) and npm for
bricolo
to enable asset compilation and live reloading.
Installation and Setup
-
Project Setup: Create a new folder for your project and open a terminal in it.
-
Install the PHP Framework: Run this command to install
partez
and its dependencies: -
Create a
.env
File: If not automatically created, create a.env
file at the project root. You can use .env.example as a reference. -
Automatic Front-End Setup with
bricolo
:bricolo
is automatically installed via npm as part of the post-create command incomposer.json
. This includes asset compilation and live reloading. If you run the create-project command with--no-script
options, you should runnpm install
to make sure thatbricolo
will be available. - Run the Development Server: Start the server with the command below to view the app in your browser at localhost:1234 (the port may change according to the other ports already in use on your machine. Please check the log in the console):
How it works
Configuration
-
HTML Customization: Modify the HTML layout in
src/views/Layout.twig
to adjust the document head. - Routing: Routes are automatically derived from controllers in
src/Controllers
using specific annotations (see below).
The Router
Define routes in src/Controllers files using PHP annotations:
- URI (
"/"
) is mandatory. - Name (
name="Home"
) specifies the route's name. - Authentification (
auth=false
) restricts the access if set totrue
(default isfalse
).
The Pages
Controllers in src/Controllers
extend the main controller (Abstract/Controller.php
). The init()
method call renderPage("Page.twig")
to render the Twig template. Each page extends the main layout in src/views/Layout.twig
.
The Public Folder
The public directory houses index.php
, as well as js
, css
and images
folders, which can be customized freely.
The API
A basic API is available in api/
and runs on a MySQL database.
Bricolo JS Automation
The Partez PHP framework includes bricolo
as an automation tool for front-end tasks, so you can focus on development without needing to handle asset compilation or live reloading setup yourself. bricolo
is installed automatically during setup, and it's already configured with a bricoloconfig.json file that defines custom settings to integrate with this project.
You can find more information on the npm of the bricolo
(js) package.
Bricolo JS Configuration
bricolo
is automatically installed within the project and configured with the file bricoloconfig.json
:
Configuration Overview
-
PHP Server: The PHP server will run on port 8080 using the command
composer serve p={port}
. -
Asset Compilation:
- JavaScript: Compiles assets/js/main.ts into a bundle at public/js/bundle.js.
- CSS: Compiles assets/css/main.scss into a minified CSS file at public/css/style.min.css.
-
File Watching:
bricolo
monitors files in specified directories (src/**/*.php
,view/**/*.twig
,public/**/*.css
, etc.) for changes, which will trigger asset compilation and live browser reload.
- Live Reload Server: The development server is set to run on port 1234 for hot reloading.
Usage
After creating the project, you can simply start the bricolo automation and server:
Or, if you prefer, use the command directly:
This command will:
- Start the PHP server on port 8080.
- Compile and watch for changes in JavaScript and Sass files.
- Automatically reload the browser at localhost:1234 whenever changes are detected in watched files.
Build with
- This kit is build in PHP, using as much as possible the MVC pattern. We use the Twig template engine to generate the pages.
- Style is now powered by Bootstrap v5.2, using the simple CDN link.
- You can add JS scripts in the public folder or wherever you want, as mentioned earlier.
The basic structure is:
Contributing
We welcome contributions! Hereβs how to contribute:
- Fork the project.
- Create your feature branch:
git checkout -b features/Myfeature
. - Commit your changes:
git commit -m "β¨ Introducing Myfeature!"
. - Push to Github:
git push origin features/Myfeature
. - Open a Pull Request.
Contact
If you have any questions, feel free to reach out:
Antoine Bollinger - LinkedIn - [email protected]
You can talk to me in π«π·, π§π· or π¬π§.
All versions of partez with dependencies
twig/twig Version ^3.8
twig/html-extra Version ^3.8
twig/intl-extra Version ^3.8
vlucas/phpdotenv Version ^5.6
abollinger/helpers Version ^1.2
abollinger/bricolo Version ^1.6
abollinger/session Version ^1.1
abollinger/router Version ^1.0