Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pollen-solutions/skeleton
Pollen Solutions - Skeleton - Project structure for standalone application
https://github.com/pollen-solutions/skeleton
php
Last synced: 6 days ago
JSON representation
Pollen Solutions - Skeleton - Project structure for standalone application
- Host: GitHub
- URL: https://github.com/pollen-solutions/skeleton
- Owner: pollen-solutions
- License: mit
- Created: 2021-07-06T13:31:11.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-31T15:39:01.000Z (over 1 year ago)
- Last Synced: 2024-04-23T00:23:37.488Z (7 months ago)
- Topics: php
- Language: Shell
- Homepage:
- Size: 1.93 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Skeleton Component
[](https://packagist.org/packages/pollen-solutions/skeleton)
[](LICENSE.md)
[](https://www.php.net/supported-versions.php)
**Skeleton** Component provides structures of standalone project based on Pollen Solutions suite.
## Table of contents
- [Features](#features)
- [Installation](#installation)
- [Standard installation](#standard-installation)
- [Docker installation](#docker-installation)
- [Configuration](#configuration)
- [Environment configuration](#environment-configuration)
- [Customize a local environment configuration](#customize-a-local-environment-configuration)
- [Environment Variable Types](#environment-variables-types)
- [Environment variable mapping](#environment-variable-mapping)
- [Use application variable](#use-application-variable)
- [Directory structure](#directory-structure)
- [The Root directory structure](#the-root-directory-structure)
- [The Root directory details](#the-root-directory-details)
## Features
The Pollen solutions **Skeleton** component embeds :
- [Composer](https://getcomposer.org/), as package manager for PHP libraries.
- [ViteJS](https://vitejs.dev/) as assets bundler and responsible for compiling, transpilating, versioning,
optimizing ...
- [Pollen solutions components suite](https://github.com/pollen-solutions) that includes :
- A dependency injection container
- A routing system
- A templating library
- An asset manager and injector
- An expandable command line interface
- An event manager
- ...
- A preconfigured Docker environment integrating :
- A light-weight command-line interface for interact with Docker easily
- A PHP server that run through Apache
- A MySQL server
- An email previewer service (MailHog)
- A sharing local application service
- ...
- ... And a lot of other kinds of magic !
To try it is already to contribute, you are welcome !
## Installation
### Standard installation
#### Prerequisite
- **PHP** must be installed on your machine [see details](https://www.php.net/manual/install.php).
- **Composer** must be installed on your machine [see details](https://getcomposer.org/download/).
#### Launch installation
```sh
composer create-project pollen-solutions/skeleton your-app-name
```
#### Serve the app
Serve your application using
the [built-in web server in PHP](https://www.php.net/manual/en/features.commandline.webserver.php) (or your server of
choice) from the ```public``` directory:
```sh
php -S 127.0.0.1:8000 -t public
```
Visit the application in the browser:
- [http://127.0.0.1:8000](http://127.0.0.1:8000)
### Docker installation
#### Prerequisite
- Docker must be installed on your machine [see details](https://docs.docker.com/get-docker/)
#### Launch installation
```sh
composer create-project pollen-solutions/skeleton your-app-name --no-install --no-scripts
```
Launch application builder
```sh
cd ./your-app-name
bin/app.build
```
Visit the application in the browser:
- [http://127.0.0.1:8000](http://127.0.0.1:8000)
Retrieve [More details about docker usage](docs/Docker.md) in a Pollen application from the built-in documentation.
## Configuration
### Environment configuration
During the installation process, the file ```.env.example``` is copied to ```.env```.
This file contains all required default configuration.
```dotenv
# ENVIRONMENT
APP_ENV=dev
APP_DEBUG=true
APP_URL=http://127.0.0.1:8000
APP_TIMEZONE=Europe/Paris
# DATABASE
DATABASE_URL=sqlite:///%%app.base_dir%%/var/database.sqlite
```
### Customize a local environment configuration
To customize your application configuration, you can directly edit the ```.env``` file, but the best practice is to
create a new ```.env.local``` file that will contain all the configuration attributes specific to your installation.
Through the ```.env.local``` file you can if necessary override an environment value declared in the ```.env``` file or
define new ones :
```dotenv
# DATABASE
DATABASE_URL=mysql://root:root@mysql:3306/pollen
#REDIS
REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
```
### Environment variables types
```dotenv
STRING_VAR=string
QUOTES_VAR="quoted variable"
EMPTY_STRING=
BOOL_VAR=true
NULL_VAR=null
```
### Environment variable mapping
You can use another existing global or previously defined environment variable like this :
```dotenv
DB_USERNAME=${MYSQL_USER}
DB_PASSWORD=${MYSQL_PASSWORD}
```
Note that, for security reasons, global environnement variables couldn't be overridden.
### Use application variable
In some special cases, you may need to access application variable to complete the
configuration of your environment variables and the merge vars could help you.
The paths of the application are natively available :
- ```%%app.base_dir%%```: Absolute path to the root directory of the app.
- ```%%app.public_dir%%```: Absolute path to the public directory of the app.
Example of usage :
```dotenv
DATABASE_URL=sqlite:///%%app.base_dir%%/var/database.sqlite
```
Pollen solutions suite uses the **vlucas/phpdotenv** library to work. More information
on its [github repository](https://github.com/vlucas/phpdotenv).
## Directory structure
The **Skeleton** component is a micro-framework.
Like other solutions of this type, it is opinionated and its directory structure is intended to provide a starting point
for creating a complete web application.
### The Root directory structure
```
|–– bin
|–– bootstrap
|–– config
|–– docker
|–– docs
|–– (node_modules)
|–– public
|–– resources
|–– assets
|–– views
|–– src
|–– tests
|–– var
|–– (vendor)
```
### The Root directory details
#### src
The ```src``` directory contains the core PHP code of your application.
#### resources
The ```resources``` directory contains the templating code. This included views and css, js, fonts, images and all other
assets files.
#### public
The ```public``` directory contains the index.php file, which is the entry point for all requests entering your
application and configures autoload.
This directory also houses the build assets such css, js, fonts, images and all other assets files.
#### config
The ```config``` directory, as the name implies, contains all of your application's PHP configuration files.
#### docs
The ```docs``` directory contains the complete documentation of the micro framework and its components.
Work in progress ;)