{"id":18315535,"url":"https://github.com/mathieutu/php-project-launcher","last_synced_at":"2026-03-09T18:39:27.822Z","repository":{"id":135922755,"uuid":"159576717","full_name":"mathieutu/php-project-launcher","owner":"mathieutu","description":"A php project launcher with Docker.","archived":false,"fork":false,"pushed_at":"2020-05-06T15:14:51.000Z","size":37,"stargazers_count":8,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-12T23:21:07.946Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mathieutu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-28T23:01:59.000Z","updated_at":"2024-06-09T18:21:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"0b39b4d0-8df5-4a49-a31b-1f836db857a2","html_url":"https://github.com/mathieutu/php-project-launcher","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/mathieutu/php-project-launcher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathieutu%2Fphp-project-launcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathieutu%2Fphp-project-launcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathieutu%2Fphp-project-launcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathieutu%2Fphp-project-launcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mathieutu","download_url":"https://codeload.github.com/mathieutu/php-project-launcher/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathieutu%2Fphp-project-launcher/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30307549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T17:35:44.120Z","status":"ssl_error","status_checked_at":"2026-03-09T17:35:43.707Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T16:41:30.037Z","updated_at":"2026-03-09T18:39:27.802Z","avatar_url":"https://github.com/mathieutu.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 PHP Project Launcher\n\nSet a flexible Docker development environment in a second.\nThis package assumes that you have docker installed, and a bash compatible operating system (actually not tested on Windows). \n\n## Set your project services\nJust once per project, in its root sources folder.\n\nIf the services are already set up for your project you can directly jump to \"[Launch the services](#launch-the-services)\" chapter.\n\n### 📦 Require the package\n```bash\n$ composer require mathieutu/php-project-launcher\n```\n\nIf you do not have php and composer on your computer you can directly use the composer docker container:\n\n```bash\n$ docker run --rm -ti -v $PWD:/app composer require mathieutu/php-project-launcher\n```\n\n*Tip: You should commit here! 😇*\n\n### 🐳 Initialize Docker files\n```bash\n$ ./vendor/bin/ppl init {project-name?}\n```\n*Tip: You can personalize the project name, or leave empty to use the directory name. \nIt will be used to automatically set your domain names: `project-name.test` and `project-name.localhost` by default. \nTo use `*.test` the developer need to edit its `hosts` or [add a dns server](https://medium.com/@narakuw/brew-install-dnsmasq-in-macos-sierra-26021c824be8), \nbut `*.localhost` should work out of the box in unix OS*\n\n### 📝 Choose your flavour\n\nEdit the `docker-compose.yml`, `docker/*`, and `.env` files to fit your needs.\n\nA standard Laravel 5 / Symfony 4 application with a PostgreSQL database should work out of the box after [updating your `.env` file](#update-your-env-file).  \n\nSee the [configuration chapter](#make-the-configuration-all-yours) for all the details.\n\n*Tip: You also should commit here 😇!*\n\n## Launch the services\nFor each developer on its computer, every time s‧he need to launch the project.\n\n### 🚀 Launch your project\n```bash\n$ ./vendor/bin/ppl up\n\n```\n*Tip: A container of [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy) will be launched as `nginx-proxy` if not found and if ther is the standard 'web' container. It will allow you to use several domain names for your projects.*\n\n## 🎉 Make great things\n\n### Update your `.env` file\n\nWith the `ppl db` command you will see all the values that you need for your `.env` file: \n```bash\n$ ./vendor/bin/ppl db\nFrom the container:\n    DB_CONNECTION=pgsql\n    DB_HOST=db\n    DB_PORT=5432\n    DB_USERNAME=root\n    DB_PASSWORD=\n    DB_DATABASE=local\n    DATABASE_URL=postgresql://root:@db:5432/local\n...\n```\n### See your project in the browser\n```bash\n$ ./vendor/bin/ppl open {path?}\n\n```\n*Tip: If you do it quickly after `up` command, you could see a 502 page. Hold tight and refresh after few seconds, it's just the time your server needs to start!*\n\n*Tip²: You can customize the domain to open with the `$PPL_OPEN` env variable in web service.*\n\n### See your database content in a dedicated software\nYou can see the public port of your database with:\n```bash\n$ ./vendor/bin/ppl db\n...\nFrom outside:\n    Type: PostgresSQL\n    Host: 127.0.0.1\n    Port: 32813\n    Username: root\n    Password: \n    Database: local\n    Url: postgresql://root:@127.0.0.1:32813/local\n```\n\n### Use your favorite framework cli tool\nYou can directly access to cli tools with:\n```bash\n$ ./vendor/bin/ppl artisan\n```\n```bash\n$ ./vendor/bin/ppl console\n```\n\n*Tip: because we never save too much time, you can directly them with `ppla` and `pplsf` aliases.*\n\nExample:\n```bash\nppla migrate\n```\n\n```bash\npplsh doctrine:migrations:migrate\n```\n\n### And more...\nYou can see all you can do with:\n\n```text\n$ ppl --help\n\nPHP Project Launcher.\n\nUsage:\n  ./vendor/bin/ppl [COMMAND] [ARGS...]\n  ./vendor/bin/ppl -h | --help\n\nCommands:\n  init               Install the docker files to set the services. Can be used with project name in parameter.\n  up | u             Run the project services (run the proxy if not already launched).\n  down | d           Stop and remove the project services.\n  reload | rl        Down and up the project services (with image rebuild).\n  open | o           Open project in web browser.\n  database | db      Show the env variables and the database connection information.           \n  artisan | a        Execute Laravel Artisan in the web service (with access to DB).\n  console | sf       Execute Symfony Console in the web service (with access to DB).\n  composer | c       Execute Composer in the web service (with proper version of php).\n  yarn | y           Execute Yarn in the web service.\n  bash | sh          Open a bash console in the web service.\n  exec | e           Execute a command in the web service.\n  inspect | i        Show the docker configuration for a service.\n  logs               View output from services.\n  ps                 List services.\n  *                  Fallback on docker-compose binary.\n```\n\n*Tip: By adding `./vendor/bin/` to your path, you will be able to directly type `ppl` instead of `./vendor/bin/ppl`. And it will be useful for all the composer binaries, like `phpunit`! For that, you just have to add `export PATH=./vendor/bin:$PATH` to your .bashrc, or .zshrc file.*\n\n\n## Make the configuration all yours\n\nA standard Laravel/Symfony application with a PostgreSQL database should work out of the box, after having configured your `.env` file.\n\nUncomment the mysql example in `docker-compose.yml` if you prefer to use it.\n\nFor now, in the original flavour, you can see the documentation pages of:\n\n- [jwilder/nginx-proxy](https://hub.docker.com/r/jwilder/nginx-proxy/): The reverse proxy that allows you to use domain names on your projects.\n- [richarvey/nginx-php-fpm](https://hub.docker.com/r/richarvey/nginx-php-fpm/): The image used to serve the web service. Directly shipped with git, nginx, php, composer, xdebug, etc.\n- [postgres](https://hub.docker.com/_/postgres/) and [mysql](https://hub.docker.com/_/mysql/) databases containers.\n- [docker](https://docs.docker.com/get-started/) and [docker-compose](https://docs.docker.com/compose/overview/) tools.\n\n\n### Customize your URLs\nIn the `docker-compose.yml` file, you will be able to customise several env variables in your web service:\n- `$VIRTUAL_HOST` which is the list of all the domain names that the proxy will redirect to this container.\n- `$PPL_OPEN` which is the root url that the command `ppl open` will use.\n\n\n**TO BE CONTINUED...**\n\n## Contribute to this project\n\nPlease feel ~~free~~ encouraged to make Issues and Pull Requests, for new features and bugs fixes as well as documentation. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieutu%2Fphp-project-launcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathieutu%2Fphp-project-launcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieutu%2Fphp-project-launcher/lists"}