Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4xxi/skeleton
4xxi Symfony Skeleton is an extension for the official Symfony Skeleton with symfony flex used in 4xxi
https://github.com/4xxi/skeleton
docker-sync php php7 skeleton-application symfony symfony-skeleton symfony3 symfony4
Last synced: 3 months ago
JSON representation
4xxi Symfony Skeleton is an extension for the official Symfony Skeleton with symfony flex used in 4xxi
- Host: GitHub
- URL: https://github.com/4xxi/skeleton
- Owner: 4xxi
- Created: 2017-12-27T12:25:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-08T14:51:08.000Z (about 4 years ago)
- Last Synced: 2024-09-30T16:02:46.632Z (4 months ago)
- Topics: docker-sync, php, php7, skeleton-application, symfony, symfony-skeleton, symfony3, symfony4
- Language: PHP
- Homepage: https://4xxi.com
- Size: 30.3 KB
- Stars: 54
- Watchers: 8
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
4xxi Symfony Skeleton
==========
4xxi Symfony Skeleton is an extension for the official [Symfony Skeleton](https://github.com/symfony/skeleton)
(recommended way for starting new projects using [Symfony Flex](https://symfony.com/doc/current/setup/flex.html)).
It's main idea is to keep simplicity of official Skeleton, while adding must-have dependencies and default configs used
in 4xxi for developing majority of the projects. It contains bare Symfony Skeleton with the following additions:
* A minimal set of must-have bundles for production environment
* ORM Pack (Doctrine + Migrations)
* FrameworkExtraBundle (Annotations)
* MonologBundle
* Sensiolabs SecurityChecker
* A set of bundles and tools that are necessary for development
* [PHP CS Fixer](https://cs.sensiolabs.org/)
* [Psalm](https://psalm.dev/docs/)
* [PhpStan](https://phpstan.org/user-guide/getting-started)
* [PhpUnit](https://symfony.com/doc/current/testing.html)
* Debug Pack (Debug + Profiler + Dumper)
* Docker Compose and Docker Sync configs optimized for development under Linux and MacOS
* Template for README.md with installation instructions
Creating new project
==========
Creating new project with 4xxi Symfony Skeleton is as easy as running
```bash
composer create-project 4xxi/skeleton
```
where `` is the directory where you want to setup a new project. New project is ready for development
immediately after this step.
## Additional configurations
### Docker
4xxi Symfony Skeleton comes with Docker configuration for local development (includes PHP 7.1, nginx and PostgreSQL)
on Linux and MacOS.
* Follow instructions in `docker-sync.yml` and `docker-compose-sync.yml` and update `project_name-data-sync` volume
with the real name of your project. This is needed to keep a unique name for data volume used by Docker Sync for
developers working simultaneously on several projects.
* Optional: Add additional PHP extensions to PHP Docker container by following instructions in
`config/docker/php/Dockerfile`.
* Optional: Add additinal services (like Redis, RabbitMQ, Elasticsearch) in docker-compose.yml.
### Add Bundles and dependencies that are required by our project
Projects created by Flex include only the mininum amount of dependencies by default. Most of additional components that
were previously a part of Symfony Standard Edition are not installed, so it is up to you to install them if they are
really needed.
Most of components could be installed and auto-configured by Flex by running:
```bash
composer req
```
The list of common Components that may be needed for the project:
* api
* asset
* twig
* workflow
* web-link
### Update installation instructions
When you are done with previous steps, update Installation Instructions and remove everything above them in this file.
Installation Instructions
==========
Everything below is a template for Installation Instructions. It should be updated with the full steps for setting up
your project.
## Requirements
* [Docker and Docker Compose](https://docs.docker.com/engine/installation)
* [MacOS Only]: Docker Sync (run `gem install docker-sync` to install it)
## Configuration
Application configuration is stored in `.env` file.
Run `cp .env.dist .env` to apply the default configuration for local installations.
### HTTP port
If you have nginx or apache installed and using 80 port on host system you can either stop them before proceeding or
reconfigure Docker to use another port by changing value of `EXTERNAL_HTTP_PORT` in `.env` file.
### Application environment
You can change application environment to `dev` of `prod` by changing `APP_ENV` variable in `.env` file.
### DB name and credentials
DB name and credentials could by reconfigured by changing variables with `POSTGRES` prefix in `.env` file. It is
recommended to restart containers after changing these values (new database will be automatically created on containers
start).
## Installation
### 1. Start Containers and install dependencies
On Linux:
```bash
docker-compose up -d
```
On MacOS:
```bash
docker-sync-stack start
```
### 2. Run migrations, install fixtures
```bash
docker-compose exec php bin/console doctrine:migrations:migrate
```
### 3. Build frontend
Place instructions to build frontend here.
### 4. Open project
Just go to [http://localhost](http://localhost)
Application commands
==========
Add application-specific console commands and their description here.
Useful commands and shortcuts
==========
## Shortcuts
It is recommended to add short aliases for the following frequently used container commands:
* `docker-compose exec php php` to run php in container
* `docker-compose exec php composer` to run composer
* `docker-compose exec php bin/console` to run Symfony CLI commands
* `docker-compose exec db psql` to run PostgreSQL commands
## Checking code style and running tests
Fix code style by running PHP CS Fixer:
```bash
docker-compose exec php vendor/bin/php-cs-fixer fix
```
Run PHP Unit Tests:
```bash
docker-compose exec php bin/phpunit
```