peak / peak
Peak Application Base
Installs: 36
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=7.2
- illuminate/database: ^5.8
- illuminate/events: ^5.8
- monolog/monolog: ^1.24
- peak/database: ^1.0
- peak/framework: ^4.1
- robmorgan/phinx: ^0.10
- zendframework/zend-diactoros: ^2.1
Requires (Dev)
- phpstan/phpstan: ^0.11.5
- phpunit/phpunit: ^8.2
This package is auto-updated.
Last update: 2024-09-20 05:06:02 UTC
README
Note: This repository contains an application skeleton for Peak framework. If you want only the framework core, visit the main framework repository.
What's inside ?
This is a skeleton of an application, or if you prefer, an opiniated web application structure and stack coming with:
- Peak Framework (PSR-7, PSR-11 and PSR-15)
- A folder structure emphasizing on clean architecture
- Laravel Database
- Phinx Migration
- Zend Diactoros (PSR-7)
- Monolog
- Docker file & docker-compose config
Install via composer
$ composer create-project peak/peak --prefer-dist
Install manually
Download https://github.com/peakphp/peak/archive/master.zip
Quick start with Docker
This project comes with a Docker configurations to help you start fast. What's included :
- PHP 7.3
- Nginx latest
- MYSQL 8
- Redis latest
- Composer install & update
- Database migration
- Shell access
How to use it ?
- Copy
.env.dist
to.env
- Install vendor with
$ docker-compose run composer-install
- Start the web server with
$ docker-compose up app
- Visit
http://localhost:8080
and voilĂ ! - Others docker commands:
$ docker-compose run migration
for database migration$ docker-compose run shell
for entering in the container with shell bash$ docker-compose run climber
for using the CLI console application$ docker-compose up adminer
for running database web manager Adminer
Don't want to use docker? Just remove:
Dockerfile
DockerfileShell
docker-compose.yml
/docker
folder
Code generator
$ docker-compose run climber codegen