igoryok-zp / symfony-realworld-example-app

Symfony + API Platform backend implementation for RealWorld

Symfony codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with Symfony including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Symfony community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

How it works

This app is using Symfony with:

• API Platform
• Doctrine ORM
• LexikJWTAuthenticationBundle

Docker services:

• Nginx
• PHP-FPM
• PostgreSQL

Code analysis:

• GrumPHP
• PHP_CodeSniffer
• PHP Mess Detector
• PHPStan

Testing:

• PHPUnit
• AliceBundle
• DoctrineTestBundle

Getting started

Run the application

Make sure you have Docker installed.

Clone the repository.

Create Docker environment file from the sample:

cp env.txt .env

Launch Docker services:

docker compose up -d

That's it, now you can open http://localhost/ in your browser.

Run tests

Override Docker settings to enable development features:

cp docker-compose.dev.yml docker-compose.override.yml

Restart Docker services:

docker compose up -d --build

Open http://localhost/ to verify the app is running fine.

Note: If you see 502 Bad Gateway reload the page a few moments later :)

Run PHPUnit:

docker compose exec app phpunit

Learn more

• Symfony: The Fast Track
• Getting Started With API Platform