{"id":14983725,"url":"https://github.com/4xxi/skeleton","last_synced_at":"2025-04-10T19:04:30.835Z","repository":{"id":55899878,"uuid":"115518625","full_name":"4xxi/skeleton","owner":"4xxi","description":"4xxi Symfony Skeleton is an extension for the official Symfony Skeleton with symfony flex used in 4xxi","archived":false,"fork":false,"pushed_at":"2020-12-08T14:51:08.000Z","size":31,"stargazers_count":54,"open_issues_count":0,"forks_count":8,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-24T16:46:01.215Z","etag":null,"topics":["docker-sync","php","php7","skeleton-application","symfony","symfony-skeleton","symfony3","symfony4"],"latest_commit_sha":null,"homepage":"https://4xxi.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/4xxi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-27T12:25:56.000Z","updated_at":"2022-05-26T18:41:41.000Z","dependencies_parsed_at":"2022-08-15T09:00:44.007Z","dependency_job_id":null,"html_url":"https://github.com/4xxi/skeleton","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4xxi%2Fskeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4xxi%2Fskeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4xxi%2Fskeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4xxi%2Fskeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/4xxi","download_url":"https://codeload.github.com/4xxi/skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248279196,"owners_count":21077406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["docker-sync","php","php7","skeleton-application","symfony","symfony-skeleton","symfony3","symfony4"],"created_at":"2024-09-24T14:07:50.108Z","updated_at":"2025-04-10T19:04:30.816Z","avatar_url":"https://github.com/4xxi.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"4xxi Symfony Skeleton\n==========\n\n4xxi Symfony Skeleton is an extension for the official [Symfony Skeleton](https://github.com/symfony/skeleton) \n(recommended way for starting new projects using [Symfony Flex](https://symfony.com/doc/current/setup/flex.html)). \nIt's main idea is to keep simplicity of official Skeleton, while adding must-have dependencies and default configs used\nin 4xxi for developing majority of the projects. It contains bare Symfony Skeleton with the following additions:\n\n* A minimal set of must-have bundles for production environment\n    * ORM Pack (Doctrine + Migrations)\n    * FrameworkExtraBundle (Annotations)\n    * MonologBundle\n    * Sensiolabs SecurityChecker\n* A set of bundles and tools that are necessary for development\n    * [PHP CS Fixer](https://cs.sensiolabs.org/)\n    * [Psalm](https://psalm.dev/docs/)\n    * [PhpStan](https://phpstan.org/user-guide/getting-started)\n    * [PhpUnit](https://symfony.com/doc/current/testing.html)\n    * Debug Pack (Debug + Profiler + Dumper)\n* Docker Compose and Docker Sync configs optimized for development under Linux and MacOS\n* Template for README.md with installation instructions\n\nCreating new project \n==========\n\nCreating new project with 4xxi Symfony Skeleton is as easy as running\n```bash\ncomposer create-project 4xxi/skeleton \u003cproject_name\u003e \n```\nwhere `\u003cproject_name\u003e` is the directory where you want to setup a new project. New project is ready for development \nimmediately after this step.\n\n## Additional configurations\n\n### Docker\n4xxi Symfony Skeleton comes with Docker configuration for local development (includes PHP 7.1, nginx and PostgreSQL)\non Linux and MacOS.\n\n* Follow instructions in `docker-sync.yml` and `docker-compose-sync.yml` and update `project_name-data-sync` volume \n  with the real name of your project. This is needed to keep a unique name for data volume used by Docker Sync for \n  developers working simultaneously on several projects.\n* Optional: Add additional PHP extensions to PHP Docker container by following instructions in \n  `config/docker/php/Dockerfile`.\n* Optional: Add additinal services (like Redis, RabbitMQ, Elasticsearch) in docker-compose.yml.\n\n### Add Bundles and dependencies that are required by our project\nProjects created by Flex include only the mininum amount of dependencies by default. Most of additional components that \nwere previously a part of Symfony Standard Edition are not installed, so it is up to you to install them if they are \nreally needed.\n\nMost of components could be installed and auto-configured by Flex by running:\n```bash\ncomposer req \u003ccomponent\u003e\n```\nThe list of common Components that may be needed for the project:\n\n* api\n* asset\n* twig\n* workflow\n* web-link\n\n### Update installation instructions\n\nWhen you are done with previous steps, update Installation Instructions and remove everything above them in this file.\n\nInstallation Instructions\n==========\n\nEverything below is a template for Installation Instructions. It should be updated with the full steps for setting up\nyour project.\n\n## Requirements\n\n* [Docker and Docker Compose](https://docs.docker.com/engine/installation)\n* [MacOS Only]: Docker Sync (run `gem install docker-sync` to install it)\n\n## Configuration\n\nApplication configuration is stored in `.env` file. \n\nRun `cp .env.dist .env` to apply the default configuration for local installations.\n\n### HTTP port\nIf you have nginx or apache installed and using 80 port on host system you can either stop them before proceeding or \nreconfigure Docker to use another port by changing value of `EXTERNAL_HTTP_PORT` in `.env` file.\n\n### Application environment\nYou can change application environment to `dev` of `prod` by changing `APP_ENV` variable in `.env` file.\n\n### DB name and credentials\nDB name and credentials could by reconfigured by changing variables with `POSTGRES` prefix in `.env` file. It is \nrecommended to restart containers after changing these values (new database will be automatically created on containers \nstart).\n\n## Installation\n\n### 1. Start Containers and install dependencies \nOn Linux:\n```bash\ndocker-compose up -d\n```\nOn MacOS:\n```bash\ndocker-sync-stack start\n```\n### 2. Run migrations, install fixtures\n```bash\ndocker-compose exec php bin/console doctrine:migrations:migrate\n```\n\n### 3. Build frontend\nPlace instructions to build frontend here.\n\n### 4. Open project\nJust go to [http://localhost](http://localhost)\n\n\nApplication commands\n==========\nAdd application-specific console commands and their description here.\n\n\nUseful commands and shortcuts\n==========\n\n## Shortcuts\nIt is recommended to add short aliases for the following frequently used container commands:\n\n* `docker-compose exec php php` to run php in container\n* `docker-compose exec php composer` to run composer\n* `docker-compose exec php bin/console` to run Symfony CLI commands\n* `docker-compose exec db psql` to run PostgreSQL commands\n\n\n## Checking code style and running tests\nFix code style by running PHP CS Fixer:\n```bash\ndocker-compose exec php vendor/bin/php-cs-fixer fix\n```\n\nRun PHP Unit Tests:\n```bash\ndocker-compose exec php bin/phpunit\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4xxi%2Fskeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F4xxi%2Fskeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4xxi%2Fskeleton/lists"}