{"id":19176662,"url":"https://github.com/sulu/sulu-workshop","last_synced_at":"2025-05-07T19:24:27.746Z","repository":{"id":49241986,"uuid":"210766954","full_name":"sulu/sulu-workshop","owner":"sulu","description":"Workshop that guides through the process of creating an application using the Sulu content management system","archived":false,"fork":false,"pushed_at":"2022-10-17T14:52:15.000Z","size":16766,"stargazers_count":51,"open_issues_count":12,"forks_count":21,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-20T01:33:12.523Z","etag":null,"topics":["cms","sulu","sulu-workshop","sulucms"],"latest_commit_sha":null,"homepage":"","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/sulu.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":"2019-09-25T06:00:49.000Z","updated_at":"2025-04-19T18:05:49.000Z","dependencies_parsed_at":"2022-09-05T06:30:38.637Z","dependency_job_id":null,"html_url":"https://github.com/sulu/sulu-workshop","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2Fsulu-workshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2Fsulu-workshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2Fsulu-workshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2Fsulu-workshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sulu","download_url":"https://codeload.github.com/sulu/sulu-workshop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252942230,"owners_count":21829029,"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":["cms","sulu","sulu-workshop","sulucms"],"created_at":"2024-11-09T10:29:30.701Z","updated_at":"2025-05-07T19:24:27.716Z","avatar_url":"https://github.com/sulu.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sulu Workshop\n\nThe Sulu workshop consists of 12 assignments that guide you through the process of creating a small website that\nintegrates two simple custom entities using the Sulu content management system. This repository contains the\n**example project**, **assignments** and **solution code** for the workshop.\nThe included example project builds upon the official [sulu/skeleton](https://github.com/sulu/skeleton) template and\nadds some implementation-specific libraries such as Bootstrap or Symfony Encore.\n\nThe **assignments** of the workshop are available via the [pull requests area](https://github.com/sulu/sulu-workshop/pulls?q=is%3Aopen+is%3Apr+label%3Aassignment+sort%3Acreated-asc) of this repository.\nEach pull requests contains the **example solution code** for the respective assignment. Feel free to use the\n**comment feature on these pull requests** for asking questions or providing additional context about the solution code.\n\n## Requirements\n\n- PHP 8.1 or higher\n- Relational Database like MySQL, MariaDB or PostgreSQL\n\n#### Optional requirements\n- [Symfony CLI Tool](https://symfony.com/doc/master/cloud/getting-started.html)\n- [Docker Engine](https://docs.docker.com/engine/installation/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\n## Getting started\n\n### Setting up your database\n\nIf you choose to run your services with docker you can startup your database by executing the following command:\n\n```bash\ndocker-compose up\n```\n\nIf you prefer to use your local database you can configure your credentials in a `.env.local` file in the root directory of the project:\n\n```dotenv\nDATABASE_URL=mysql://DB_USER:DB_PASSWORD@127.0.0.1:3306/DB_NAME\n```\n\n### Installing the dependencies\n\nUse [composer](https://getcomposer.org/) to install the dependencies of the project:\n\n```bash\ncomposer install\n```\n\n### Initialize the Sulu Database\n\nRun the following command to initialize the database that will be used by Sulu:\n\n```bash\nbin/console sulu:build dev --destroy\n```\n\n### Run Webserver\n\nYou can startup the built-in PHP web-server with:\n\n```bash\nphp -S localhost:8009 -t public config/router.php\n```\n\nIf you have the SYMFONY CLI Tools installed and want to increase your performace you can also use the following command to startup the SYMFONY webserver:\n\n```bash\nsymfony server:start\n```\n\n## Development\n\nThe project setup in the repository includes several development tools that help you to improve the quality of your code\n\n### PHPUnit\n\nThe project already contains some unit tests and functional tests. They can be executed with the following commands:\n\n```bash\n# create and update test database\ncomposer bootstrap-test-environment\n\n# execute all test cases\ncomposer test\n```\n\nYou can can pass additional phpunit arguments by appending `-- \u003carguments\u003e` to the `composer test` command.\n\n```bash\ncomposer test -- --stop-on-fail\n```\n\n### PHP-CS-Fixer and Rector\n\nTo keep your code consistent you can automatically reformat your code with the following command:\n\n```bash\ncomposer fix\n```\n\n### PHPStan\n\nPHPStan helps you to catch bugs before they actually occur by statically analyzing your code. Use following command to run it:\n\n```bash\ncomposer phpstan\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsulu%2Fsulu-workshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsulu%2Fsulu-workshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsulu%2Fsulu-workshop/lists"}