sulu-workshop

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 48 Open GitHub ↗

Workshop that guides through the process of creating an application using the Sulu content management system

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sulu Workshop

The Sulu workshop consists of 12 assignments that guide you through the process of creating a small website that
integrates two simple custom entities using the Sulu content management system. This repository contains the
**example project**, **assignments** and **solution code** for the workshop.
The included example project builds upon the official [sulu/skeleton](https://github.com/sulu/skeleton) template and
adds some implementation-specific libraries such as Bootstrap or Symfony Encore.

The **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.
Each pull requests contains the **example solution code** for the respective assignment. Feel free to use the
**comment feature on these pull requests** for asking questions or providing additional context about the solution code.

## Requirements

- PHP 8.1 or higher
- Relational Database like MySQL, MariaDB or PostgreSQL

#### Optional requirements
- [Symfony CLI Tool](https://symfony.com/doc/master/cloud/getting-started.html)
- [Docker Engine](https://docs.docker.com/engine/installation/)
- [Docker Compose](https://docs.docker.com/compose/install/)

## Getting started

### Setting up your database

If you choose to run your services with docker you can startup your database by executing the following command:

```bash
docker-compose up
```

If you prefer to use your local database you can configure your credentials in a `.env.local` file in the root directory of the project:

```dotenv
DATABASE_URL=mysql://DB_USER:DB_PASSWORD@127.0.0.1:3306/DB_NAME
```

### Installing the dependencies

Use [composer](https://getcomposer.org/) to install the dependencies of the project:

```bash
composer install
```

### Initialize the Sulu Database

Run the following command to initialize the database that will be used by Sulu:

```bash
bin/console sulu:build dev --destroy
```

### Run Webserver

You can startup the built-in PHP web-server with:

```bash
php -S localhost:8009 -t public config/router.php
```

If 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:

```bash
symfony server:start
```

## Development

The project setup in the repository includes several development tools that help you to improve the quality of your code

### PHPUnit

The project already contains some unit tests and functional tests. They can be executed with the following commands:

```bash
# create and update test database
composer bootstrap-test-environment

# execute all test cases
composer test
```

You can can pass additional phpunit arguments by appending `-- <arguments>` to the `composer test` command.

```bash
composer test -- --stop-on-fail
```

### PHP-CS-Fixer and Rector

To keep your code consistent you can automatically reformat your code with the following command:

```bash
composer fix
```

### PHPStan

PHPStan helps you to catch bugs before they actually occur by statically analyzing your code. Use following command to run it:

```bash
composer phpstan
```

sulu-workshop

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README